fintop 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.0.2 (4/6/2014)
+
+- Add -a option for displaying info on other users' Finagle processes
+- Fetch Java processes in Ruby rather than shelling out to `jps`
+- Add -v/--version command-line options
+- Add -h/--help command-line options
+
 # 0.0.1 (4/1/2014)
 
 - Initial version of Fintop. Probes stats and threads endpoints of Finagle

data/README.md

@@ -4,8 +4,14 @@ A top-like utility for monitoring [Finagle](http://github.com/twitter/finagle) s
 
 ## Installation
 
-The `fintop` gem hasn't been published yet, so is currently only usable from
-source. To install `fintop` locally, clone this repository and run
+### From RubyGems.org
+
+`fintop` is distributed as [an executable Ruby gem](https://rubygems.org/gems/fintop).
+To install it from the RubyGems.org, simply run `gem install fintop`.
+
+### From source
+
+To install `fintop` locally from source, clone this repository and run
 `rake install` from within the repository's root directory.
 
 ## Usage

data/bin/fintop

@@ -1,9 +1,16 @@
 #!/usr/bin/env ruby
 
 require 'fintop/printer'
-require 'fintop/probe'
-require 'fintop/threads'
-
-finagle_procs = Fintop::Probe.apply
-Fintop::Printer.apply(finagle_procs)
 
+option = ARGV[0]
+if option == '-v' or option == '--version'
+  Fintop::Printer.print_version
+  exit
+elsif option == '-h' or option == '--help'
+  Fintop::Printer.print_help
+  exit
+else
+  require 'fintop/probe'
+  finagle_procs = Fintop::Probe.apply(option == '-a')
+  Fintop::Printer.apply(finagle_procs)
+end

data/fintop.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.authors       = ['Evan Meagher']
   s.email         = ['evan.meagher@gmail.com']
   s.summary       = %q{A top-like utility for monitoring Finagle servers}
+  s.description   = %q{Fintop is a top-like monitoring tool Finagle servers}
   s.license       = 'MIT'
 
   s.files         = `git ls-files -z`.split("\x0")
@@ -21,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'test-unit', '~> 2.5'
 
   s.add_dependency 'json'
+  s.add_dependency 'sys-proctable', '~> 0.9.4'
 end

data/lib/fintop/printer.rb

@@ -1,5 +1,5 @@
 require 'fintop/metrics'
-require 'pp'
+require 'fintop/threads'
 
 module Fintop
   # Contains functions that gather and print operational data on local
@@ -63,10 +63,49 @@ module Fintop
       }
     end
 
+    # Print fintop version.
+    def print_version
+      require 'fintop/version'
+      puts "fintop version #{Fintop::VERSION}"
+    end
+
+    # Print help output.
+    def print_help
+      puts 'usage: fintop [-v|--version] [-h|--help] [-a]'
+      puts
+      puts 'Options:'
+      printf(@@option_format_str, '-a', 'Display info about other users\' ' \
+                                        'Finagle processes as well as your own')
+      printf(@@option_format_str, '-v, --version',
+        'Print the version number of Fintop being run')
+      printf(@@option_format_str, '-h, --help', 'Print help output')
+      puts
+      puts 'Column Labels:'
+      @@columns.each { |label, description|
+        printf(@@column_label_format_str, label, description)
+      }
+    end
+
     private
 
     @@row_format_str = "%-7s %-6s %-5s %-5s %-6s %-6s %-7s %-8s %-10s %-10s\n"
 
+    # Help output format strings.
+    @@option_format_str =       "   %s\n      %s\n"
+    @@column_label_format_str = "   %-8s %s\n"
+    @@columns = [
+      ['PID',   'The process identifier of the Finagle process'],
+      ['PORT',  'The admin port opened by the process'],
+      ['CPU',   'The number of CPUs allocated to the process'],
+      ['#TH',   'The total number of threads within the process'],
+      ['#NOND', 'The number of non-daemon threads within the process'],
+      ['#RUN',  'The number of runnable threads within the process'],
+      ['#WAIT', 'The number of waiting threads within the process'],
+      ['#TWAIT','The number of threads within the process that are waiting on a timer'],
+      ['TXKB',  'The sum of data (in KB) transmitted by the Finagle process'],
+      ['RXKB',  'The sum of data (in KB) received by the Finagle process']
+    ]
+
     # Print a total process/thread synopsis and column headers.
     #
     # @param threads_data_hash [Hash<Fixnum, ThreadsData>] a hash of pids and
@@ -89,19 +128,7 @@ module Fintop
            "#{runnable_threads} runnable, "\
            "#{waiting_threads} waiting"
       puts
-      printf(
-        @@row_format_str,
-        'PID',
-        'PORT',
-        'CPU',
-        '#TH',
-        '#NOND',
-        '#RUN',
-        '#WAIT',
-        '#TWAIT',
-        'TXKB',
-        'RXKB'
-      )
+      printf(@@row_format_str, *(@@columns.map { |label, desc| label }))
     end
   end
 end

data/lib/fintop/probe.rb

@@ -1,4 +1,5 @@
 require 'net/http'
+require 'sys/proctable'
 require 'timeout'
 
 module Fintop
@@ -23,19 +24,23 @@ module Fintop
     #
     # Probing targets are Java processes listening on a TCP socket serving
     # the path "/admin". Function returns an array of FinagleProcess objects
-    def apply
-      # Invoke jps and filter out nailgun servers and the jps process itself.
-      jps_cmd_str = '$JAVA_HOME/bin/jps | '\
-                    'grep -v NGServer | '\
-                    'grep -v Jps | '\
-                    "awk '{print $1}'"
+    #
+    # @param include_other_users [Boolean] if true, other users' Java
+    # processes will be probed in addition to the current user's
+    def apply(include_other_users = false)
+      java_ps = Sys::ProcTable.ps.select { |s| s.comm == 'java' }
 
-      finagle_pids = `#{jps_cmd_str}`.split.map { |pid|
-        # Filter for the processes that are listening on a TCP port.
-        lsof_cmd_str = "lsof -P -i tcp -a -p #{pid} | grep LISTEN | awk '{print $9}'"
+      listening_java_ps = java_ps.map { |s|
+        # Filter by user, pid, and existence of a listened-on TCP port.
+        user_filter_str = include_other_users ? "-u #{s.ruid}" : ''
+        lsof_cmd_str = "lsof -P #{user_filter_str} -i tcp -a -p #{s.pid} " \
+                       "| grep LISTEN " \
+                       "| awk '{print $9}'"
         port_match = /\d+/.match(`#{lsof_cmd_str}`)
-        port_match && [pid, port_match[0]]
-      }.compact.map { |pid, admin_port|
+        port_match && [s.pid, port_match[0]]
+      }.compact
+
+      listening_java_ps.map { |pid, admin_port|
         # Probe the possible ping endpoints to determine which (if any) stats
         # library is in use.
         begin

data/lib/fintop/version.rb

@@ -1,3 +1,3 @@
 module Fintop
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fintop
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Evan Meagher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-04-01 00:00:00 -07:00
+date: 2014-04-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,7 +76,23 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id004
-description: 
+- !ruby/object:Gem::Dependency 
+  name: sys-proctable
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  type: :runtime
+  version_requirements: *id005
+description: Fintop is a top-like monitoring tool Finagle servers
 email: 
 - evan.meagher@gmail.com
 executables: