nogara-redis_failover 0.9.7.3 → 0.9.7.4

data/Changes.md

@@ -1,11 +1,13 @@
 HEAD
 -----------
-- redis_failover now supports distributed monitoring among the node managers! Previously, the node managers were only used
-as a means of redundancy in case a particular node manager crashed. Starting with version 1.0 of redis_failover, the node
-managers will all periodically report their health report/snapshots. The primary node manager will utilize a configurable
+- redis_failover now supports distributed monitoring among the Node Managers! Previously, the Node Managers were only used
+as a means of redundancy in case a particular node manager crashed. Starting with version 1.0 of redis_failover, the Node
+Managers will all periodically report their health report/snapshots. The primary Node Manager will utilize a configurable
 "node strategy" to determine if a particular node is available or unavailable.
 - redis_failover now supports a configurable "failover strategy" that's consulted when performing a failover. Currently,
 a single strategy is provided that takes into account the average latency of the last health check to the redis server.
+- Improved handling of underlying ZK client connection in RedisFailover::NodeManager
+- Add support for passing in an existing ZK client instance to RedisFailover::Cient.new
 
 0.9.7.2
 -----------

data/README.md

@@ -90,6 +90,9 @@ would look like the following:
 
     ---
     :max_failures: 2
+    :node_strategy: majority
+    :failover_strategy: latency
+    :required_node_managers: 2
     :nodes:
       - localhost:6379
       - localhost:1111
@@ -115,22 +118,30 @@ this Node Manager process dies or becomes partitioned from the network, another
 will be promoted as the primary manager of redis servers. You can run as many Node Manager
 processes as you'd like. Every Node Manager periodically records health "snapshots" which the
 primary/master Node Manager consults when determining if it should officially mark a redis 
-server as unavailable. By default, a majority strategy is used.
+server as unavailable. By default, a majority strategy is used. Also, when a failover
+happens, the primary Node Manager will consult the node snapshots to determine the best
+node to use as the new master.
 
 ## Client Usage
 
 The redis failover client must be used in conjunction with a running Node Manager daemon. The
 client supports various configuration options, however the only mandatory option is the list of
-ZooKeeper servers:
+ZooKeeper servers OR an existing ZK client instance:
 
+    # Explicitly specify the ZK servers
     client = RedisFailover::Client.new(:zkservers => 'localhost:2181,localhost:2182,localhost:2183')
 
+    # Explicitly specify an existing ZK client instance (useful if using a connection pool, etc)
+    zk = ZK.new('localhost:2181,localhost:2182,localhost:2183')
+    client = RedisFailover::Client.new(:zk => zk)
+
 The client actually employs the common redis and redis-namespace gems underneath, so this should be
 a drop-in replacement for your existing pure redis client usage.
 
 The full set of options that can be passed to RedisFailover::Client are:
 
-     :zkservers     - comma-separated ZooKeeper host:port pairs (required)
+     :zk            - an existing ZK client instance
+     :zkservers     - comma-separated ZooKeeper host:port pairs
      :znode_path    - the Znode path override for redis server list (optional)
      :password      - password for redis nodes (optional)
      :db            - db to use for redis nodes (optional)

data/lib/redis_failover/client.rb

@@ -40,6 +40,7 @@ module RedisFailover
     #
     # @param [Hash] options the options used to initialize the client instance
     # @option options [String] :zkservers comma-separated ZooKeeper host:port
+    # @option options [String] :zk an existing ZK client connection instance
     # @option options [String] :znode_path znode path override for redis nodes
     # @option options [String] :password password for redis nodes
     # @option options [String] :db database to use for redis nodes
@@ -49,6 +50,7 @@ module RedisFailover
     # @option options [Integer] :max_retries max retries for a failure
     # @option options [Boolean] :safe_mode indicates if safe mode is used or not
     # @option options [Boolean] :master_only indicates if only redis master is used
+    # @note Use either :zkservers or :zk
     # @return [RedisFailover::Client]
     def initialize(options = {})
       Util.logger = options[:logger] if options[:logger]
@@ -177,8 +179,8 @@ module RedisFailover
 
     # Sets up the underlying ZooKeeper connection.
     def setup_zk
-      @zk = ZK.new(@zkservers)
-      @zk.watcher.register(redis_nodes_path) { |event| handle_zk_event(event) }
+      @zk = ZK.new(@zkservers) if @zkservers
+      @zk.register(redis_nodes_path) { |event| handle_zk_event(event) }
       if @safe_mode
         @zk.on_expired_session { purge_clients }
       end
@@ -475,7 +477,11 @@ module RedisFailover
     #
     # @param [Hash] options the configuration options
     def parse_options(options)
-      @zkservers = options.fetch(:zkservers) { raise ArgumentError, ':zkservers required'}
+      @zk, @zkservers = options.values_at(:zk, :zkservers)
+      if [@zk, @zkservers].all? || [@zk, @zkservers].none?
+        raise ArgumentError, 'must specify :zk or :zkservers'
+      end
+
       @root_znode = options.fetch(:znode_path, Util::DEFAULT_ROOT_ZNODE_PATH)
       @namespace = options[:namespace]
       @password = options[:password]

data/lib/redis_failover/version.rb

@@ -1,3 +1,3 @@
 module RedisFailover
-  VERSION = '0.9.7.3'
+  VERSION = '0.9.7.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nogara-redis_failover
 version: !ruby/object:Gem::Version
-  version: 0.9.7.3
+  version: 0.9.7.4
   prerelease: 
 platform: ruby
 authors: