memcache-client-stats 1.0.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+= 1.0
+=== 3rd July, 2006
+
+* Initial checkin.

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2006 Layton Wedgeworth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,99 @@
+== memcache-client-stats
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/memcacheclientstats
+
+== About
+
+memcache-client-stats is an add on to memcache-client that adds the ability to query memcache server stats from the client.
+
+== Installing memcache-client-stats
+
+Just install the gem
+
+  $ sudo gem install memcache-client-stats
+  
+== Using memcache-client-stats
+
+Create a new MemCache instance
+  >> require 'memcache_client_stats'
+  >> CACHE = MemCache.new :c_threshold => 10_000,
+                       :compression => true,
+                       :debug => false,
+                       :namespace => 'my_namespace',
+                       :readonly => false,
+                       :urlencode => false
+  >> CACHE.servers = ['192.168.0.100:11211', '192.168.0.101:11211']
+  
+
+You can then query the cluster for the stats.  You can request all the stats for all the servers in the memcache cluster:
+
+  >> CACHE.stats
+  => {"192.168.0.100:11211" =>
+       {"bytes" => "211986835",
+        "pid" => "1942",
+        "connection_structures" => "75",
+        "time" => "1151612629",
+        "limit_maxbytes" => "268435456",
+        "cmd_get" => "6484010",
+        "version" => "1.1.12",
+        "bytes_written" => "930827121",
+        "cmd_set" => "6274655",
+        "get_misses" => "1930031",
+        "total_connections" => "115",
+        "curr_connections" => "17",
+        "curr_items" => "1040445",
+        "uptime" => "2486978",
+        "get_hits" => "4553979",
+        "total_items" => "6274655",
+        "rusage_system" => "781.900865",
+        "rusage_user" => "392.372521",
+        "bytes_read" => "1476127655
+       },
+      "192.168.0.101:11211" =>
+       {"bytes" => "210778808",
+        "pid" => "9993",
+        "connection_structures" => "237",
+        "time" => "1151612630",
+        "limit_maxbytes" => "268435456",
+        "cmd_get" => "23683207",
+        "version" => "1.1.12",
+        "bytes_written" => "3407983178",
+        "cmd_set" => "22942962",
+        "get_misses" => "5708419",
+        "total_connections" => "1948",
+        "curr_connections" => "17",
+        "curr_items" => "1073593",
+        "uptime" => "5782293",
+        "get_hits" => "17974788",
+        "total_items" => "22942962",
+        "rusage_system" => "2279.002428",
+        "rusage_user" => "1287.636472",
+        "bytes_read" => "5160467749
+       }
+     }
+
+Or you can request a single stat from all servers:
+ 
+   >> CACHE.stats('bytes')
+   => {"192.168.0.53:11211" = >"211985845", "192.168.0.50:11211" => "210776435"}
+ 
+You can also have the client summarize the statistic across the cluster:
+
+   >> CACHE.summed_stat('curr_items')
+   => 2114039
+   >> CACHE.summed_stat('bytes') / 1.megabyte
+   => 403
+   
+=== Using memcache-client-stats with Rails
+
+memcache-client-stats includes the <tt>MemCache.load_config</tt> method that will automatically load the memcache configuration and initialize the client
+based on a .yml configuration file (think database.yml for memcache-client).  An example file is available at examples/memcache.yml.
+
+You can configure Rails to use memcache-client by adding the following to config/environment.rb or config/environment/*.rb
+
+  require 'memcache_client_stats'
+  CACHE = MemCache.load_config("#{RAILS_ROOT}/config/memcache.yml")
+  config.action_controller.session_store = :mem_cache_store
+  ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS.merge! :cache => CACHE

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+include FileUtils
+
+NAME = "memcache-client-stats"
+VERS = "1.0.0"
+TITLE = "memcache-client-stats Documentation"
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', TITLE,
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+desc "Packages up memcache-client-stats."
+task :default => [:rdoc, :package]
+task :package => [:clean]
+
+task :doc => [:rdoc]
+
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc/rdoc'
+    rdoc.options += RDOC_OPTS
+    rdoc.main = "README"
+    rdoc.title = TITLE
+    rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/memcache_client_stats.rb', 'lib/memcache_config.rb', 
+                         'lib/memcache_server.rb', 'lib/memcache_stats.rb']
+end
+
+spec =
+    Gem::Specification.new do |s|
+        s.name = NAME
+        s.version = VERS
+        s.platform = Gem::Platform::RUBY
+        s.has_rdoc = true
+        s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
+        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples)\/']
+        s.summary = "Query MemCache server stats through memcache-client"
+        s.description = s.summary
+        s.author = "Layton Wedgeworth"
+
+        s.add_dependency('memcache-client')
+        s.required_ruby_version = '>= 1.8.2'
+
+        s.files = %w(COPYING README Rakefile) +
+          Dir.glob("{bin,doc,lib}/**/*") + 
+          Dir.glob("examples/**/*.rb")
+
+        s.require_path = "lib"
+    end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = true
+    p.gem_spec = spec
+end
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end

data/lib/memcache_client_stats.rb

@@ -0,0 +1,5 @@
+require_gem 'memcache-client'
+
+require 'memcache_config'
+require 'memcache_server'
+require 'memcache_stats'

data/lib/memcache_config.rb

@@ -0,0 +1,16 @@
+class MemCache
+  # Loads the configuration from the given filename and creates a new MemCache
+  # instance that uses the options and servers from the configuration file.
+  # 
+  # See examples/memcache.yml for an example configuration file.
+  def MemCache.load_config(filename = nil, environment = nil)
+    filename ||= "#{RAILS_ROOT}/config/memcache.yml"
+    environment ||= RAILS_ENV
+
+    config = YAML.load_file(filename)[environment]
+    instance = MemCache.new(config['options'])
+    instance.servers = config['servers']
+      
+    instance
+  end
+end

data/lib/memcache_server.rb

@@ -0,0 +1,40 @@
+class MemCache
+  # Extends the MemCache::Server object so that is is able to request stats.
+  class Server
+    # Returns a unique key for the server.
+    def key
+      "#{host}:#{port}"
+    end
+
+    # Returns the open socket or raises a MemCache::MemCacheError if one is not available.
+    def socket!
+      socket or raise MemCacheError, "No connection to server"
+    end
+
+    # Returns a hash of <tt>{stat_key => value, ...}</tt> for all of the Server stats.
+    def stats
+      sock = socket!
+
+      stats = {}
+      begin
+        sock.write "stats\r\n"
+
+        # Loop through the status which are sent back in the format of:
+        # STAT <name> <value>\r\n
+        # and ends with
+        # END\r\n
+        while (text = sock.gets)
+          break if text =~ /^END/
+          
+          s, name, value = text.split(/ /)
+          stats[name] = value[0..-3]
+        end
+      rescue SystemCallError, IOError => err
+        server.close
+        raise MemCacheError, err.message
+      end
+
+      stats
+    end
+  end
+end

data/lib/memcache_stats.rb

@@ -0,0 +1,32 @@
+class MemCache
+  # Creates a hash for the stat(s) for all of the active servers.  
+  # 
+  # If <tt>key</tt> is <tt>nil</tt> then the returned hash will be in the form of
+  # <tt>{server1 => {stat_key => value, ...}, server2 => {stat_key => value, ...}, ...}</tt>
+  # for all of the servers and stats.
+  # 
+  # If <tt>key</tt> is not <tt>nil</tt> then the returned hash will be in the form of
+  # <tt>{server1 => value, server2 => value, ...}</tt> for all servers for the single requested stat.
+  def stats(key = nil)
+    stats = {}
+
+    @mutex.synchronize do
+      raise MemCacheError, "No active servers" unless self.active?
+      @servers.each {|server| stats[server.key] = server.stats}
+    end
+    
+    unless key.nil?
+      new_stats = {}
+      stats.each_pair {|k,v| new_stats[k] = v[key]}
+      stats = new_stats
+    end
+
+    stats
+  end
+
+  # Returns a summed value for the requested stat.  This is useful for determining things such
+  # as the global number of <tt>curr_items</tt> or <tt>bytes</tt>.
+  def summed_stat(key)
+    stats(key).values.inject(0) {|sum, value| sum + value.to_i}
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: memcache-client-stats
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-07-03 00:00:00 -07:00
+summary: Query MemCache server stats through memcache-client
+require_paths: 
+- lib
+email: 
+homepage: 
+rubyforge_project: 
+description: Query MemCache server stats through memcache-client
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Layton Wedgeworth
+files: 
+- COPYING
+- README
+- Rakefile
+- lib/memcache_stats.rb
+- lib/memcache_client_stats.rb
+- lib/memcache_config.rb
+- lib/memcache_server.rb
+- CHANGELOG
+test_files: []
+
+rdoc_options: 
+- --quiet
+- --title
+- memcache-client-stats Documentation
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples)\/
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- COPYING
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: