tcptop 0.0.1 → 0.1.0

data/README.md

@@ -1,24 +1,44 @@
 # Tcptop
 
-TODO: Write a gem description
+A TCP connection monitor that builds upon [raindrops](http://raindrops.bogomips.org/). Useful for monitoring a pool of unicorn workers.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'tcptop'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Install it using:
 
     $ gem install tcptop
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ tcptop -h
+    Usage: tcptop [options]
+    -t, --tcp SOCKET                 tcp socket to filter, can be used multiple times
+    -u, --unix PATH                  domain socket to filter, can be used multiple times, will not show by default
+    -1, --once                       print once and exit
+    -n, --interval SECONDS           seconds between stat collection, DEFAULT: 2
+        --queued                     sort on queued requests, defaults to active
+        --collectd LABEL             print output suitable for collectd, must also provide socket or path
+    -v, --version                    prints the version and exits
+
+Output:
+
+    $ tcptop -1
+    Socket               Active*  Queued 
+    0.0.0.0:22           3        0      
+    0.0.0.0:8080         1        1      
+    [::%2510935584]:22   0        0      
+    [::%2510935584]:80   0        0      
+    [::1%2510935584]:25  0        0      
+    127.0.0.1:25         0        0      
+    127.0.0.1:11211      0        0      
+
+## Domain Sockets
+
+Unix sockets do not show up by default, if you wish to monitor a unix socket, you must pass the --unix flag
+
+    $ tcptop -1 --unix /tmp/foo.sock
+    Socket               Active*  Queued
+    /tmp/foo.sock        0        0     
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/tcptop/collectd.rb

@@ -0,0 +1,10 @@
+module Tcptop
+  class Collectd
+    def self.reading(active, queued, hostname, label, io=STDOUT)
+      time = Time.now.to_i
+      io.write "PUTVAL #{hostname}/#{label}/absolute-active #{time}:#{active}\n"
+      io.write "PUTVAL #{hostname}/#{label}/absolute-queued #{time}:#{queued}\n"
+      io.flush
+    end
+  end
+end

data/lib/tcptop/version.rb

@@ -1,3 +1,3 @@
 module Tcptop
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/tcptop.rb

@@ -1,4 +1,5 @@
 require "tcptop/version"
+require "tcptop/collectd"
 require 'rubygems'
 require 'raindrops'
 require 'optparse'
@@ -7,13 +8,16 @@ LAYOUT = "%-20s %-8s %-8s"
 
 module Tcptop
   def self.parse_options!
-    options = {:tcp => [], :interval => 2, :sort => :active}
+    options = {:tcp => [], :unix => [], :interval => 2, :sort => :active}
     OptionParser.new do |opts|
       opts.banner = "Usage: tcptop [options]"
 
       opts.on("-t", "--tcp SOCKET", "tcp socket to filter, can be used multiple times") do |sock|
         options[:tcp] << sock
       end
+      opts.on("-u", "--unix PATH", "domain socket to filter, can be used multiple times, will not show by default") do |path|
+        options[:unix] << path
+      end
       opts.on("-1", "--once", "print once and exit") do
         options[:once] = true
       end
@@ -23,6 +27,9 @@ module Tcptop
       opts.on("--queued", "sort on queued requests, defaults to active") do
         options[:sort] = :queued
       end
+      opts.on("--collectd LABEL", "print output suitable for collectd, must also provide socket or path") do |label|
+        options[:collectd] = label
+      end
       opts.on("-v", "--version", "prints the version and exits") do
         options[:version] = true
       end
@@ -36,8 +43,29 @@ module Tcptop
       puts "tcptop: version #{Tcptop::VERSION}"
       exit 0
     elsif options[:once]
-      print_info(options[:tcp], options[:sort])
+      print_info(options[:tcp], options[:unix], options[:sort])
       exit 0
+    elsif options[:collectd]
+      unless options[:tcp].size == 1 || options[:unix].size == 1
+        puts "the --tcp or --unix option must be used once to identify the socket"
+        exit 1
+      end
+
+      Signal.trap("INT") { exit 0 }
+      hostname = ENV["COLLECTD_HOSTNAME"] || 'localhost'
+      interval = (ENV["COLLECTD_INTERVAL"] || '60').to_i
+      label = options[:collectd]
+
+      loop do
+        stats = nil
+        if options[:tcp].size > 0
+          _, stats = Raindrops::Linux.tcp_listener_stats(options[:tcp]).first
+        else
+          _, stats = Raindrops::Linux.unix_listener_stats(options[:unix]).first
+        end
+        Collectd.reading(stats.active, stats.queued, hostname, label)
+        sleep interval
+      end
     else
       Signal.trap("INT") { exit 0 }
 
@@ -45,19 +73,21 @@ module Tcptop
         system "clear"
         puts "Updated: #{Time.now}, checking every #{options[:interval]} seconds"
         puts
-        print_info(options[:tcp], options[:sort])
+        print_info(options[:tcp], options[:unix], options[:sort])
         sleep options[:interval]
       end
     end
   end
 
-  def self.print_info(sockets, sort)
+  def self.print_info(sockets, paths, sort)
     puts LAYOUT % [
       "Socket",
       "Active" + (sort == :active ? "*" : ""),
       "Queued" + (sort == :queued ? "*" : "")
     ]
-    responses = if sockets.empty?
+    responses = if paths.any?
+                  Raindrops::Linux.unix_listener_stats(paths)
+                elsif sockets.empty?
                   Raindrops::Linux.tcp_listener_stats
                 else
                   Raindrops::Linux.tcp_listener_stats(sockets)

data/test/collectd_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class CollectdTest < Test::Unit::TestCase
+  def test_outputs_two_putvals_for_active_and_queued
+    s = ""
+    Tcptop::Collectd.reading(10, 2, 'localhost', 'unicorn', StringIO.new(s))
+
+    lines = s.split("\n")
+    assert_equal 2, lines.size
+    assert_match %r{PUTVAL localhost/unicorn/absolute-active \d+:10}, lines.first
+    assert_match %r{PUTVAL localhost/unicorn/absolute-queued \d+:2}, lines.last
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'tcptop'
+require 'test/unit'

metadata

@@ -1,72 +1,78 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: tcptop
-version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Tony Pitluga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-10-30 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: raindrops
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 11
+        - 0
         version: 0.11.0
-- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: A monitoring tool for TCP connections
-email:
+email: 
 - tony.pitluga@gmail.com
-executables:
+executables: 
 - tcptop
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -74,31 +80,45 @@ files:
 - Rakefile
 - bin/tcptop
 - lib/tcptop.rb
+- lib/tcptop/collectd.rb
 - lib/tcptop/version.rb
 - tcptop.gemspec
+- test/collectd_test.rb
+- test/test_helper.rb
+has_rdoc: true
 homepage: http://github.com/pitluga/tcptop
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A monitoring tool for TCP connections
-test_files: []
+test_files: 
+- test/collectd_test.rb
+- test/test_helper.rb