memcache-client-stats 1.0.0 → 1.1.0

data/CHANGELOG

@@ -1,4 +1,8 @@
-= 1.0
-=== 3rd July, 2006
+*1.1.0* (July 6th, 2006)
+
+* Expanded the abilities to be able to query different memcache stat types (malloc, items, slabs) as well as specific keys. [Chris Wanstrath]
+
+
+*1.0.0* (July 3rd, 2006)
 
 * Initial checkin.

data/README

@@ -76,8 +76,39 @@ You can then query the cluster for the stats.  You can request all the stats for
 
 Or you can request a single stat from all servers:
  
-   >> CACHE.stats('bytes')
+   >> CACHE.stats(:key => 'bytes')
    => {"192.168.0.53:11211" = >"211985845", "192.168.0.50:11211" => "210776435"}
+
+You can also specify which type of stats you'd like to receive:
+
+   >> CACHE.stats(:type => 'items')
+   => {"192.168.0.100:11211" =>
+        {"fastbin_space"=>"0",
+         "mmapped_space"=>"233046016",
+         "releasable_space"=>"1504",
+         "arena_size"=>"1724416",
+         "mmapped_regions"=>"224",
+         "fastbin_blocks"=>"0",
+         "total_free"=>"446832",
+         "free_chunks"=>"33",
+         "total_alloc"=>"1277584",
+         "max_total_alloc"=>"0"
+        },
+       "192.168.0.101:11211" =>
+        {"fastbin_space"=>"0",
+         "mmapped_space"=>"215797760",
+         "releasable_space"=>"3920",
+         "arena_size"=>"1781760",
+         "mmapped_regions"=>"205",
+         "fastbin_blocks"=>"0",
+         "total_free"=>"209200",
+         "free_chunks"=>"28",
+         "total_alloc"=>"1572560",
+         "max_total_alloc"=>"0"
+        }
+      }
+
+Valid stat types (besides the default): slabs malloc items
  
 You can also have the client summarize the statistic across the cluster:
 
@@ -85,6 +116,11 @@ You can also have the client summarize the statistic across the cluster:
    => 2114039
    >> CACHE.summed_stat('bytes') / 1.megabyte
    => 403
+
+This works with an optional second parameter specifying the type, as well:
+
+  >> CACHE.summed_stat('arena_size', 'malloc')
+  => 5177344
    
 === Using memcache-client-stats with Rails
 
@@ -96,4 +132,4 @@ You can configure Rails to use memcache-client by adding the following to config
   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
+  ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS.merge! :cache => CACHE

data/Rakefile

@@ -6,7 +6,7 @@ require 'fileutils'
 include FileUtils
 
 NAME = "memcache-client-stats"
-VERS = "1.0.0"
+VERS = "1.1.0"
 TITLE = "memcache-client-stats Documentation"
 CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', TITLE,

data/lib/memcache_server.rb

@@ -1,4 +1,6 @@
 class MemCache
+  STAT_TYPES = %w[items malloc slabs]
+
   # Extends the MemCache::Server object so that is is able to request stats.
   class Server
     # Returns a unique key for the server.
@@ -12,12 +14,16 @@ class MemCache
     end
 
     # Returns a hash of <tt>{stat_key => value, ...}</tt> for all of the Server stats.
-    def stats
+    def stats(type = nil)
+      unless type.nil? || STAT_TYPES.include?(type)
+        raise MemCacheError, "Not a valid stat type.  Valid stat types are: #{STAT_TYPES * ', '}"
+      end
+
       sock = socket!
 
       stats = {}
       begin
-        sock.write "stats\r\n"
+        sock.write "stats#{type ? ' ' + type : nil}\r\n"
 
         # Loop through the status which are sent back in the format of:
         # STAT <name> <value>\r\n
@@ -37,4 +43,4 @@ class MemCache
       stats
     end
   end
-end
+end

data/lib/memcache_stats.rb

@@ -1,18 +1,36 @@
 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
+  # By default, 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
+  # Stats accepts a hash of optional arguments:
+  #
+  # 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)
+  #
+  # i.e. <tt>CACHE.stats(:key => 'bytes')</tt>
+  #
+  # If <tt>:type</tt> is not <tt>nil</tt>, the passed <tt>stats</tt> type will be returned as a hash.
+  #
+  # i.e. <tt>CACHE.stats(:type => 'slabs')</tt>
+  #
+  # Valid <tt>:type</tt> options are: slabs malloc items
+  # 
+  # _Deprecation_ _notice_: if <tt>options</tt> is not a hash then it will be used as the key.
+  # Please note that this usage is considered deprecated and will possibily be removed in future versions.
+  # 
+  # i.e. <tt>CACHE.stats('bytes')</tt>
+  def stats(options = {})
     stats = {}
 
+    key  = options.is_a?(Hash) ? options[:key] : options
+    type = options[:type] if options.is_a?(Hash)
+
     @mutex.synchronize do
       raise MemCacheError, "No active servers" unless self.active?
-      @servers.each {|server| stats[server.key] = server.stats}
+      @servers.each {|server| stats[server.key] = server.stats(type)}
     end
     
     unless key.nil?
@@ -26,7 +44,9 @@ class MemCache
 
   # 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}
+  #
+  # Can optionally be passed a <tt>type</tt> as a second parameter.
+  def summed_stat(key, type = nil)
+    stats({:key => key, :type => type}).values.inject(0) {|sum, value| sum + value.to_i}
   end
 end

metadata

@@ -3,8 +3,8 @@ 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
+  version: 1.1.0
+date: 2006-07-06 00:00:00 -07:00
 summary: Query MemCache server stats through memcache-client
 require_paths: 
 - lib
@@ -31,10 +31,10 @@ files:
 - COPYING
 - README
 - Rakefile
-- lib/memcache_stats.rb
-- lib/memcache_client_stats.rb
 - lib/memcache_config.rb
 - lib/memcache_server.rb
+- lib/memcache_stats.rb
+- lib/memcache_client_stats.rb
 - CHANGELOG
 test_files: []