nutcracker 0.2.4.beta3 → 0.2.4.mac9

data/README.md

@@ -3,15 +3,15 @@
 
 This library wraps Twitter's [Nutcracker](https://github.com/twitter/twemproxy) in a gem package and provides a simple ruby API to the `nutcracker` executable.
 
-### DISCLAIMER
-this is still a work in progress...
+### Disclaimer
+this project is still in its early stages, so things could be a little buggy, if you find one, feel free to [report](https://github.com/kontera-technologies/nutcracker/issues) it.
 
 ## Motivation
 The main motivation here is to take the advantages of working with Bundler's dependencies management and to be able to embed Twitter's [Nutcracker](https://github.com/twitter/twemproxy) as a dependency to any Ruby project, this allow you to create small-configuration-only-apps tied to specific version of Nutcracker as I show in the example bellow.
 
 ## Plugins
 - [nutcracker-graphite](https://github.com/kontera-technologies/nutcracker-graphite) - Send cluster stats to Graphite
-- [nutcracker-ui](https://github.com/kontera-technologies/nutcracker-ui) - Web interface for admin operations and graphs
+- [nutcracker-web](https://github.com/kontera-technologies/nutcracker-web) - Web interface
 
 ### Installation 
 Add this line to your application's Gemfile:
@@ -68,9 +68,18 @@ nutcracker.start
 nutcracker.join # wait for server to exit
 ```
 
-## Wanna build a new version?
+you can also attach to a running instance of nutcracker
+
+```ruby
+Nutcracker.attach(config_file: 'cluster.yaml', stats_port: 22222)
+```
+
+### Building new gems
 * Set the version @ `lib/nutcracker/version.rb` ( [Available Versions](https://code.google.com/p/twemproxy/downloads/list) )
 * run the `rake build` command
 * look for `nutcracker-X.Y.Z` gem under the pkg folder
 
+### Warranty
+This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
+
 > for more details like licensing etc, please look @ [Nutcracker](https://github.com/twitter/twemproxy)

data/Rakefile

@@ -18,7 +18,7 @@ task :download do
     File.open("ext/nutcracker/extconf.rb",'w') do |file|
       file.puts %q{
         raise "no support for #{RUBY_PLATFORM}" if RUBY_PLATFORM =~ /darwin|mswin|mingw/
-        system './configure'
+        system "./configure --prefix=#{File.expand_path('..',__FILE__)}"
         system 'make'
       }
     end

data/ext/nutcracker/extconf.rb

@@ -0,0 +1,3 @@
+system "./configure --prefix=#{File.expand_path('..',__FILE__)}"
+system 'make'
+  

data/lib/nutcracker.rb

@@ -2,65 +2,183 @@ require 'nutcracker/version'
 require 'socket'
 require 'json'
 require 'yaml'
+require 'redis'
 
 module Nutcracker
-
+  # Syntactic sugar for launching the Nutcracker service ( see {Wrapper#initialize} )
+  # @return [Wrapper] Nutcracker process wrapper
+  # @example
+  #  Nutcracker.start config_file: 'conf/nutcracker.yaml'
   def self.start options
     Nutcracker::Wrapper.new(options).start
   end
-
+  
+  # Connect to a running instance of Nutcracker ( see {Wrapper#initialize} )
+  # @return [Wrapper] Nutcracker process wrapper
+  # @example
+  #  Nutcracker.attach :config_file: 'conf/nutcracker.yaml', :stats_port => 22222
+  def self.attach options
+    Nutcracker::Wrapper.new options.merge attached: true
+  end
+  
+  # Returns the Nutcracker executable path that is embeded with the gem
   def self.executable
     File.expand_path("../../ext/nutcracker/src/nutcracker", __FILE__)
   end
 
+  # Returns the version string
   def self.version
     Nutcracker::VERSION
   end
 
   class Wrapper
-    attr_reader :pid, :config_file
+    attr_reader :pid
 
+    # Initialize a new Nutcracker process wrappper
+    # @param [Hash] options
+    # @option options [String] :config_file (conf/nutcracker.yaml) path to nutcracker's configuration file
+    # @option options [String] :stats_port (22222) Nutcracker stats listing port
+    # @option options [Array] :args ([]) array with additional command line arguments
     def initialize options
-      @config_file = options.fetch :config_file
+      @options = validate defaults.merge options
     end
-
-    def start
-      return if running?
-      @pid = ::Process.spawn Nutcracker.executable, '-c', config_file
+    
+    # launching the Nutcracker service
+    def start *args
+      return if attached? or running?
+      @pid = ::Process.spawn Nutcracker.executable, *command
       Kernel.at_exit { kill if running? }
       self
     end
-
+    
+    # Returns the current running status
     def running?
-      !!(pid and ::Process.getpgid pid rescue false)
+      attached? ? stats.any? : !!(pid and ::Process.getpgid pid rescue false)
     end
-
+    
+    # Returns true if the current instance was initialize with the attached flag
+    def attached?
+      @options[:attached]
+    end
+    
+    # Stops the Nutcracker service
     def stop
       sig :TERM
     end
-
+    
+    # Kills the Nutcracker service
     def kill
       sig :KILL
     end
-
+    
+    # Wait for the process to exit
     def join
-      running! and ::Process.waitpid2 pid
-    end
-
-    def stats
-      JSON.parse TCPSocket.new('localhost',22222).read rescue {}
+      attached? ? sleep : (running! and ::Process.waitpid2 pid)
     end
 
+    # Returns Nutcracker's configuration hash
     def config
-      @config ||= YAML.load_file config_file
+      @config ||= YAML.load_file @options[:config_file]
     end
 
-    # syntactic sugar for initialize plugins
+    # Syntactic sugar for initialize plugins
     def use plugin, *args
-      Nutcracker.const_get("#{plugin.to_s.capitalize}").start(self,*args)
+      Nutcracker.const_get(plugin.to_s.capitalize).start(self,*args)
+    end
+    
+    # Returns hash with server and node statistics 
+    # See example.json @ project root to get details about the structure
+    def overview
+      data = { :clusters => [], :config => config }
+
+      stats.each do |cluster_name, cluster_data|
+        # Setting global server attributes ( like hostname, version etc...)
+        unless cluster_data.is_a? Hash
+          data[cluster_name] = cluster_data
+          next
+        end
+      
+        next unless redis? cluster_name # skip memcached clusters
+        
+        aliases = node_aliases cluster_name
+        cluster = { nodes: [], name: cluster_name }
+        cluster_data.each do |node, node_value|
+          # Adding node
+          if node_value.kind_of? Hash
+            node_data = cluster_data[node]
+            node = aliases[node] || node
+            url = ( node =~ /redis\:\/\// ) ? node : "redis://#{node}"
+            info = redis_info(url)
+            cluster[:nodes] << {
+              server_url: url, info: info, running: info.any?
+            }.merge(node_data)
+          else # Cluster attribute
+            cluster[node] = node_value
+          end
+        end
+        data[:clusters].push cluster
+      end
+      data
+    end
+    
+    # Check if a given cluster name was configure as Redis
+    def redis? cluster
+      config[cluster]["redis"] rescue false
+    end
+    
+    # https://github.com/twitter/twemproxy/blob/master/notes/recommendation.md#node-names-for-consistent-hashing
+    def node_aliases cluster
+      Hash[config[cluster]["servers"].map(&:split).each {|o| o[0]=o[0].split(":")[0..1].join(":")}.map(&:reverse)]
+    end
+    
+    # Returns hash with information about a given Redis
+    def redis_info url
+      begin
+        redis = Redis.connect(url: url) 
+        info = redis.info
+        db_size = redis.dbsize
+        max_memory = redis.config(:get, 'maxmemory')['maxmemory'].to_i
+        redis.quit
+      rescue Exception
+        return {}
+      end
+      
+      {
+        'connections'     => info['connected_clients'].to_i,
+        'used_memory'     => info['used_memory'].to_f,
+        'used_memory_rss' => info['used_memory_rss'].to_f,
+        'fragmentation'   => info['mem_fragmentation_ratio'].to_f,
+        'expired_keys'    => info['expired_keys'].to_i,
+        'evicted_keys'    => info['evicted_keys'].to_i,
+        'hits'            => info['keyspace_hits'].to_i,
+        'misses'          => info['keyspace_misses'].to_i,
+        'keys'            => db_size,
+        'max_memory'      => max_memory,
+        'hit_ratio'       => 0
+      }.tap {|d| d['hit_ratio'] = d['hits'].to_f / (d['hits']+d['misses']).to_f if d['hits'] > 0 }
+    end
+
+    # Returns a hash with server statistics
+    def stats
+      JSON.parse TCPSocket.new('127.0.0.1',@options[:stats_port]).read rescue {}
     end
 
     private
+    
+    def command
+      ['-c', @options[:config_file],'-s',@options[:stats_port],*@options[:args]].map(&:to_s)
+    end
+    
+    def defaults
+      { :args => [],
+        :config_file => 'conf/nutcracker.yaml',
+        :stats_port => 22222,
+        :attached => false}
+    end
+    
+    def validate options
+      options.tap { File.exists? options[:config_file] or raise "#{options[:config_file]} not found" }
+    end
 
     def running!
       running? or raise RuntimeError, "Nutcracker isn't running..." 

data/lib/nutcracker/version.rb

@@ -1,3 +1,3 @@
 module Nutcracker
-  VERSION = "0.2.4.beta3"
+  VERSION = "0.2.4.mac9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nutcracker
 version: !ruby/object:Gem::Version
-  version: 0.2.4.beta3
+  version: 0.2.4.mac9
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-26 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -43,11 +43,28 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.14.0
-description: Gem/Bundler benefits for Twitter's Nutcraker C app
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem wrapper for Twitter's Nutcracker
 email: eran@kontera.com
 executables:
 - nutcracker
-extensions: []
+extensions:
+- ext/nutcracker/extconf.rb
 extra_rdoc_files: []
 files:
 - README.md
@@ -398,7 +415,8 @@ files:
 homepage: http://www.kontera.com
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --no-private --protected lib/**/*.rb - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -418,5 +436,5 @@ rubyforge_project: ruby-nutcracker
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Twitter's Nutcraker Gem Wrapper
+summary: Gem wrapper for Twitter's Nutcracker
 test_files: []