druid_config 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34faeb23be9dfd54181862f172bb5db8b794f489
-  data.tar.gz: 58c09b7c65c33be02e1b2cf0f9ca8eaa3754666f
+  metadata.gz: bf454ef0181ed1e25627d5cfc70229feb60acc4b
+  data.tar.gz: b71143a30e604c6463738ea4a543a9775e50768d
 SHA512:
-  metadata.gz: 64062d2ad8ec0abc2487a003feb746d175aaf6cc8b47b703fbc1544e1a59bd1089209c6d61d164678cbe469884ebefff97f0114cec7884bc63daea73b44df45f
-  data.tar.gz: 7149d8613c814c63ae21ccae898a0205dcbe479a5b0973f757d462a4d8b4d47a5ebefff5fd1cda6527b73e61222c68ff221dc893523735ae33e579617422b129
+  metadata.gz: a3c56389d7dbc9778bb6c29091e8538da10b3dd1856e32d266290cfe3fa94e8d4ecea7b3d77997e793f00818c7a89831d40f38d25901a17d6a052a5dddc32240
+  data.tar.gz: 67ef3c716e5561a6043a009298039c01247a060356eba2f5d209a374c88f254c3bbde2ee99f4241d2618b2c8e7980921598878d3af39ae67b63324b0e636cebc

data/README.md

@@ -61,7 +61,13 @@ Some methods return an instance of an `Entity` class. These entities provide mul
 
 ## Exceptions
 
-Sometimes the Gem can't access to Druid API. In this case, the gem automatically will reset the Zookeeper connection and retry the query. If second query fails too, a `DruidApiError` exception will be raised.
+### DruidConfig::Exceptions::NotAvailableNodes
+
+This exception will be raised when you try to perform a query to a Druid Coordinator or Overlord but there aren't any node of that type available.
+
+### DruidConfig::Exceptions::DruidApiError
+
+Sometimes the Gem have available nodes, but it can't access to Druid API. In this case, the gem automatically will reset the Zookeeper connection and retry the query. If second query fails too, a `DruidConfig::Exceptions::DruidApiError` exception will be raised.
 
 # Collaborate
 

data/lib/druid_config/client.rb

@@ -9,23 +9,32 @@ module DruidConfig
     # Initialize Zookeeper connection
     #
     def initialize(zookeeper, opts = {})
-      @zookeeper = :zk
+      # Store it for future resets
+      @zookeeper = zookeeper
       @opts = opts
       @zk = ZK.new(zookeeper, opts)
     end
 
     #
-    # Get the URL of a coordinator
+    # Get the URL of a coordinator.
+    #
+    # This funciton can raise a DruidConfig::Exceptions::NotAvailableNodes
+    # exception indicating there aren't any node to process this request
     #
     def coordinator
-      zk.coordinator
+      return zk.coordinator if zk.coordinator
+      fail DruidConfig::Exceptions::NotAvailableNodes, 'coordinator'
     end
 
     #
     # Get the URI of a overlord
     #
+    # This funciton can raise a DruidConfig::Exceptions::NotAvailableNodes
+    # exception indicating there aren't any node to process this request
+    #
     def overlord
-      zk.overlord
+      return zk.overlord if zk.overlord
+      fail DruidConfig::Exceptions::NotAvailableNodes, 'overlord'
     end
 
     #

data/lib/druid_config/exceptions.rb

@@ -0,0 +1,23 @@
+module DruidConfig
+  #
+  # Module of DruidConfgi exceptions
+  #
+  module Exceptions
+    # Get Global standard error
+    class StandardError < ::StandardError; end
+    #
+    # Indicate there aren't any node available in Zookeeper to run the data.
+    # It returns the name of the service user is trying to call.
+    #
+    class NotAvailableNodes < StandardError
+      def initialize(service)
+        super("There aren't any available #{service} node")
+      end
+    end
+
+    #
+    # Exception class for an error to connect the API
+    #
+    class DruidApiError < StandardError; end
+  end
+end

data/lib/druid_config/util.rb

@@ -20,12 +20,12 @@ module DruidConfig
       begin
         yield
       rescue HTTParty::RedirectionTooDeep => e
-        raise(DruidApiError, e) if @retries > 0
+        raise(DruidConfig::Exceptions::DruidApiError, e) if @retries > 0
         @retries += 1
         reset!
         retry
       rescue Errno::ECONNREFUSED => e
-        raise(DruidApiError, e) if @retries > 0
+        raise(DruidConfig::Exceptions::DruidApiError, e) if @retries > 0
         @retries += 1
         reset!
         retry

data/lib/druid_config/version.rb

@@ -4,7 +4,7 @@
 module DruidConfig
   module Version
     # Version of the gem
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
 
     # Base URI foor coordinator queries
     API_VERSION = 'v1'

data/lib/druid_config/zk.rb

@@ -34,6 +34,7 @@ module DruidConfig
       @registry = Hash.new { |hash, key| hash[key] = [] }
       @discovery_path = opts[:discovery_path] || '/discovery'
       @watched_services = {}
+      @verify_retry = 0
       register
     end
 
@@ -84,8 +85,7 @@ module DruidConfig
     def random_node(service)
       return nil if @registry[service].size == 0
       # Return a random broker from available brokers
-      i = Random.rand(@registry[service].size)
-      @registry[service][i][:uri]
+      @registry[service].sample[:uri]
     end
 
     #
@@ -94,7 +94,7 @@ module DruidConfig
     def register_service(service, brokers)
       $log.info("druid.zk register", service: service, brokers: brokers) if $log
       # poor mans load balancing
-      @registry[service] = brokers.shuffle
+      @registry[service] = brokers
     end
 
     #
@@ -146,7 +146,9 @@ module DruidConfig
     end
 
     #
-    # Verify is a Coordinator is available
+    # Verify is a Coordinator is available. To do check, this method perform a
+    # GET request to the /status end point. This method will retry to connect
+    # three times with a delay of 0.8, 1.6, 2.4 seconds.
     #
     # == Parameters:
     # name::
@@ -162,6 +164,7 @@ module DruidConfig
       info = @zk.get("#{watch_path(service)}/#{name}")
       node = JSON.parse(info[0])
       uri = "http://#{node['address']}:#{node['port']}/"
+      # Try to get /status
       check = RestClient::Request.execute(
         method: :get, url: "#{uri}status",
         timeout: 5, open_timeout: 5
@@ -169,43 +172,59 @@ module DruidConfig
       $log.info("druid.zk verified", uri: uri, sources: check) if $log
       return uri if check.code == 200
     rescue
-      return false
+      return false unless @verify_retry < 3
+      # Sleep some time and retry
+      @verify_retry += 1
+      sleep 0.8 * @verify_retry
+      retry
+    ensure
+      # Reset verify retries
+      @verify_retry = 0
     end
 
     #
-    # Watch path of a service
+    # Return the path of a service in Zookeeper.
+    #
+    # == Parameters:
+    # service::
+    #   String with the name of the service
     #
     def watch_path(service)
       "#{@discovery_path}/#{service}"
     end
 
     #
-    # Check a service
+    # Check a given Druid service. Now we only need to track coordinator and
+    # overlord services. This method create a watcher to the service to check
+    # changes.
+    #
+    # This method get the available nodes in the Zookeeper path. When return
+    # them, it tries to connect to /status end point to check if the node
+    # is available. After it, it store in @registry.
+    #
+    # == Parameters:
+    # service::
+    #   String with the service to check
     #
     def check_service(service)
+      # Only watch some services
       return if @watched_services.include?(service) ||
                 !SERVICES.include?(service)
-
       # Start to watch this service
       watch_service(service)
+      # New list of nodes
+      new_list = []
 
-      known = @registry[service].map { |node| node[:name] }
+      # Verify every node
       live = @zk.children(watch_path(service), watch: true)
-      new_list = @registry[service].select { |node| live.include?(node[:name]) }
-      $log.info("druid.zk checking", service: service, known: known, live: live, new_list: new_list) if $log
-
-      # verify the new entries to be living brokers
-      (live - known).each do |name|
+      live.each do |name|
+        # Verify a node
         uri = verify_node(name, service)
+        # If != false store the URI
         new_list.push(name: name, uri: uri) if uri
       end
-
-      if new_list.empty?
-        # don't show services w/o active brokers
-        unregister_service(service)
-      else
-        register_service(service, new_list)
-      end
+      # Register new service in the registry
+      register_service(service, new_list)
     end
 
     #

data/lib/druid_config.rb

@@ -9,6 +9,7 @@ require 'net/http'
 require 'druid_config/zk'
 require 'druid_config/version'
 require 'druid_config/util'
+require 'druid_config/exceptions'
 require 'druid_config/entities/segment'
 require 'druid_config/entities/rule'
 require 'druid_config/entities/rule_collection'
@@ -22,11 +23,6 @@ require 'druid_config/client'
 
 # Base namespace of the gem
 module DruidConfig
-  #
-  # Exception class for an error to connect the API
-  #
-  class DruidApiError < StandardError; end
-  
   # Global client of Druidconfig module
   @client = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: druid_config
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Angel M Miguel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zk
@@ -170,6 +170,7 @@ files:
 - lib/druid_config/entities/task.rb
 - lib/druid_config/entities/tier.rb
 - lib/druid_config/entities/worker.rb
+- lib/druid_config/exceptions.rb
 - lib/druid_config/util.rb
 - lib/druid_config/validators/rule_validator.rb
 - lib/druid_config/version.rb