mctop 0.0.3 → 0.0.4

data/README.md

@@ -8,16 +8,18 @@ bandwidth.
 You can read more detail about why this tool evovled over on our
 [code as craft](http://codeascraft.etsy.com/2012/12/13/mctop-a-tool-for-analyzing-memcache-get-traffic) blog.
 
-mctop depends on the [ruby-pcap](https://rubygems.org/gems/ruby-pcap) gem, if you don't have 
-this installed you'll need to ensure you have the development pcap libraries (libpcap-devel 
+mctop depends on the [ruby-pcap](https://rubygems.org/gems/ruby-pcap) gem, if you don't have
+this installed you'll need to ensure you have the development pcap libraries (libpcap-devel
 package on most linux distros) to build the native gem.
 
+![](http://etsycodeascraft.files.wordpress.com/2012/12/mctop.jpg)
+
 ## How it works
 
 mctop sniffs network traffic collecting memcache `VALUE` responses and calculates from
 traffic statistics for each key seen.  It currently reports on the following metrics per key:
 
-* **calls** - the number of times the key has been called since mctop started 
+* **calls** - the number of times the key has been called since mctop started
 * **objsize** - the size of the object stored for that key
 * **req/sec** - the number of requests per second for the key
 * **bw (kbps)** - the estimated netowrk bandwidth consumed by this key in kilobits-per-second
@@ -37,6 +39,7 @@ the quickest way to get it running is to:
 
     Usage: mctop [options]
         -i, --interface=NIC              Network interface to sniff (required)
+        -p, --port=PORT                  Network port to sniff on (default 11211)
         -d, --discard=THRESH             Discard keys with request/sec rate below THRESH
         -r, --refresh=MS                 Refresh the stats display every MS milliseconds
         -h, --help                       Show usage info
@@ -61,8 +64,12 @@ The following details are displayed in the status bar
 * `packets` - packets received and dropped by libpcap (% is percentage of packets dropped)
 * `rt` - the time taken to sort and render the stats
 
+## Changelog
+
+* 2012-12-14 - Now compatible with Ruby 1.8.x (tested on 1.8.7-p371)
+
 ## Known issues / Gotchas
 
 ### ruby-pcap drops packets at high volume
-from my testing the ruby-pcap native interface to libpcap struggles to keep up with high packet rates (in what we see on a production memcache instance) you can keep an eye on the packets recv/drop and loss percentage on the status bar at the bottom of the UI to get an idea of the packet 
+from my testing the ruby-pcap native interface to libpcap struggles to keep up with high packet rates (in what we see on a production memcache instance) you can keep an eye on the packets recv/drop and loss percentage on the status bar at the bottom of the UI to get an idea of the packet
 

data/bin/mctop

@@ -6,6 +6,7 @@
 
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
+require 'rubygems'
 require 'cmdline'
 require 'sniffer'
 require 'ui'

data/lib/cmdline.rb

@@ -10,15 +10,21 @@ class CmdLine
                 @config[:nic] = nic
             end
 
+            opt.on('-p', '--port=PORT', 'Network port to sniff on (default 11211)') do |port|
+                @config[:port] = port
+            end
+
+            @config[:discard_thresh] = 0
             opt.on '-d', '--discard=THRESH', Float, 'Discard keys with request/sec rate below THRESH' do |discard_thresh|
                 @config[:discard_thresh] = discard_thresh
             end
 
+            @config[:refresh_rate] = 500
             opt.on '-r', '--refresh=MS', Float, 'Refresh the stats display every MS milliseconds' do |refresh_rate|
                 @config[:refresh_rate] = refresh_rate
             end
 
-            opt.on_tail '-h', '--help', 'Show usage info' do 
+            opt.on_tail '-h', '--help', 'Show usage info' do
                 puts opts
                 exit
             end

data/lib/sniffer.rb

@@ -1,10 +1,12 @@
 require 'pcap'
+require 'thread'
 
-class MemcacheSniffer 
+class MemcacheSniffer
     attr_accessor :metrics, :semaphore
 
     def initialize(config)
         @source    = config[:nic]
+        @port      = config.has_key?(:port) ? config[:port] : 11211
 
         @metrics = {}
         @metrics[:calls]   = {}
@@ -18,12 +20,12 @@ class MemcacheSniffer
 
     def start
         cap = Pcap::Capture.open_live(@source, 1500)
-        
+
         @metrics[:start_time] = Time.new.to_f
 
         @done      = false
 
-        cap.setfilter('port 11211')
+        cap.setfilter("port #{@port}")
         cap.loop do |packet|
             @metrics[:stats] = cap.stats
 

data/lib/ui.rb

@@ -4,12 +4,14 @@ include Curses
 
 class UI
     def initialize(config)
+	@config = config
+
         init_screen
         cbreak
         curs_set(0)
 
         # set keyboard input timeout - sneaky way to manage refresh rate
-        Curses.timeout = config.has_key?(:refresh_rate) ? config[:refresh_rate] : 500
+        Curses.timeout = @config[:refresh_rate]
 
         if can_change_color?
             start_color
@@ -22,9 +24,6 @@ class UI
         @stat_col_width = 10 
         @key_col_width  = 0
 
-        # we will delete any keys from the metrics table whose req/sec rate is below discard_rate
-        @discard_thresh = config.has_key?(:discard_thresh) ? config[:discard_thresh] : 0
-
         @commands = {
             'Q' => "quit",
             'C' => "sort by calls",
@@ -63,7 +62,7 @@ class UI
 
         # calculate packet loss ratio
         if sniffer.metrics[:stats][:recv] > 0
-            loss = (sniffer.metrics[:stats][:drop].to_f / sniffer.metrics[:stats][:recv].to_f) * 100
+            loss = sprintf("%5.2f", (sniffer.metrics[:stats][:drop].to_f / sniffer.metrics[:stats][:recv].to_f) * 100)
         else
             loss = 0
         end
@@ -74,7 +73,7 @@ class UI
         header_summary = sprintf "%-28s %-14s %-30s", 
             "sort mode: #{sort_mode.to_s} (#{sort_order.to_s})",
             "keys: #{sniffer.metrics[:calls].keys.count}",
-            "packets (recv/dropped): #{sniffer.metrics[:stats][:recv]} / #{sniffer.metrics[:stats][:drop]} (#{loss.round(2)}%)" 
+            "packets (recv/dropped): #{sniffer.metrics[:stats][:recv]} / #{sniffer.metrics[:stats][:drop]} (#{loss}%)" 
         addstr(sprintf "%-#{cols}s", header_summary)
 
         # reset colours for main key display
@@ -95,7 +94,7 @@ class UI
                     # if req/sec is <= the discard threshold delete those keys from
                     # the metrics hash - this is a hack to manage the size of the
                     # metrics hash in high volume environments
-                    if reqsec <= @discard_thresh 
+                    if reqsec <= @config[:discard_thresh]
                         sniffer.metrics[:calls].delete(k)
                         sniffer.metrics[:objsize].delete(k)
                         sniffer.metrics[:reqsec].delete(k)
@@ -151,7 +150,20 @@ class UI
     end
 
     def input_handler
-        getch
+        # Curses.getch has a bug in 1.8.x causing non-blocking
+        # calls to block reimplemented using IO.select
+        if RUBY_VERSION =~ /^1.8/
+	     refresh_secs = @config[:refresh_rate].to_f / 1000 
+
+            if IO.select([STDIN], nil, nil, refresh_secs)
+                c = getch
+                c.chr
+            else
+                nil
+            end
+        else
+            getch
+        end
     end
 
     def done

data/mctop.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "mctop"
-  gem.version       = "0.0.3"
+  gem.version       = "0.0.4"
   gem.authors       = ["Marcus Barczak"]
   gem.email         = ["marcus@etsy.com"]
   gem.description   = %q{mctop - a realtime memcache key analyzer}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mctop
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pcap