instrumental_tools 0.1.1 → 0.2.0

data/README.md

@@ -1,17 +1,19 @@
 # Instrumental Tools
 
-Collection of tools for use with the Instrumental (http://www.instrumentalapp.com/) app
+A collection of tools for use with Instrumental ([www.instrumental.com](http://www.instrumentalapp.com/))
 
 ## instrument_server
 
 Use to collect various monitoring statistics of a server. Execute with:
 
 ```sh
-instrument_server [INSTRUMENTAL_API_KEY]
+instrument_server -k <INSTRUMENTAL_API_KEY>
 ```
 
 Linux note: Install iostat (part of the sysstat package) in order to collect disk I/O metrics.
 
+Mac OS note: Due to a bug in Ruby, instrument_server can occasionally deadlock ([bug report](http://bugs.ruby-lang.org/issues/5811)).
+
 ## instrumental
 
 Output text graphs of the different metrics in your project.

data/bin/instrument_server

@@ -1,9 +1,17 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
-gem 'instrumental_agent'
+begin
+  gem 'instrumental_agent'
+rescue Gem::LoadError
+  puts "Requires the Instrumental Agent gem:\n"
+  puts '  gem install instrumental_agent'
+  exit 1
+end
 require 'instrumental_agent'
-
+require 'pidly'
+require 'tmpdir'
+require 'optparse'
 
 class SystemInspector
   TYPES = [:gauges, :incrementors]
@@ -127,7 +135,6 @@ class SystemInspector
     def self.load_filesystem
       {}
     end
-
   end
 
   module Linux
@@ -233,36 +240,119 @@ class SystemInspector
       }
     end
   end
-
 end
 
-token = ENV["INSTRUMENTAL_TOKEN"]
-if !token
-  token, collector = *ARGV
-else
-  collector = *ARGV
-end
-unless token
-  puts "Usage: #{$0} <token> [collector]"
-  exit 1
+class ServerController < Pidly::Control
+  COMMANDS = [:start, :stop, :status, :restart, :clean, :kill]
+
+  attr_accessor :run_options
+
+  before_start do
+    puts "Starting daemon process: #{@pid}"
+  end
+
+  start :run
+
+  stop do
+    puts "Attempting to kill daemon process: #{@pid}"
+  end
+
+  # after_stop :something
+
+  error do
+    puts 'Error encountered'
+  end
+
+  def self.run(options)
+    agent = Instrumental::Agent.new(options[:api_key], :collector => [options[:collector], options[:port]].compact.join(':'))
+    puts "Collecting stats under the hostname: #{options[:hostname]}"
+    loop do
+      inspector = SystemInspector.new
+      inspector.load_all
+      inspector.gauges.each do |stat, value|
+        agent.gauge("#{options[:hostname]}.#{stat}", value)
+      end
+      # agent.increment("#{host}.#{stat}", delta)
+      sleep 10
+    end
+  end
+
+  def initialize(options={})
+    @run_options = options.delete(:run_options) || {}
+    super(options)
+  end
+
+  def run
+    self.class.run(run_options)
+  end
+
+  alias_method :clean, :clean!
 end
-options = collector.nil? ? {} : { :collector => collector }
-I = Instrumental::Agent.new(token, options)
 
-host = `hostname`.chomp
+def terminal_messages
+  if `which iostat`.chomp.empty?
+    puts 'Install iostat (sysstat package) to collect disk I/O metrics.'
+  end
+end
 
-puts "Collecting stats under the hostname: #{host}"
+def require_api_key(options, parser)
+  unless options[:api_key] # present?
+    print parser.help
+    exit 1
+  end
+end
 
-unless system('iostat > /dev/null 2>&1')
-  puts 'Install iostat (sysstat package) to collect disk I/O metrics.'
+options = {
+  :daemon => false,
+  :collector => 'instrumentalapp.com',
+  :port => '8000',
+  :hostname => `hostname`.chomp,
+}
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: instrument_server [-k API_KEY] [options] [-d #{ServerController::COMMANDS.join('|')}]"
+  opts.on('-k', '--api_key API_KEY', 'API key of your project') do |api_key|
+    options[:api_key] = api_key
+  end
+  opts.on('-c', '--collector COLLECTOR[:PORT]', "Collector (default #{options[:collector]}:#{options[:port]})") do |collector|
+    address, port = collector.split(':')
+    options[:collector] = address
+    options[:port] = port if port
+  end
+  opts.on('-d', '--daemonize', 'Run as daemon') do
+    options[:daemon] = true
+  end
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    terminal_messages
+    exit
+  end
 end
 
-loop do
-  inspector = SystemInspector.new
-  inspector.load_all
-  inspector.gauges.each do |stat, value|
-    I.gauge("#{host}.#{stat}", value)
+option_parser.parse!
+options[:api_key] ||= ENV["INSTRUMENTAL_TOKEN"]
+
+if options.delete(:daemon)
+  @server_controller = ServerController.spawn(
+    :name => 'instrument_server',
+    :path => Dir.tmpdir,
+    :pid_file => File.join(Dir.tmpdir, 'pids', 'instrument_server.pid'),
+    :verbose => true,
+    # :signal => 'kill',
+    :log_file => File.join(Dir.tmpdir, 'log', 'instrument_server.log'),
+    :run_options => options
+  )
+  command = ARGV.first && ARGV.first.to_sym
+  command ||= :start
+  if [:start, :restart].include?(command)
+    require_api_key(options, option_parser)
   end
-  # I.increment("#{host}.#{stat}", delta)
-  sleep 10
+  if ServerController::COMMANDS.include?(command)
+    @server_controller.send command
+  else
+    puts "Command must be one of: #{ServerController::COMMANDS.join(', ')}"
+  end
+else
+  require_api_key(options, option_parser)
+  ServerController.run(options)
 end

data/instrumental_tools.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_runtime_dependency(%q<json>, [">=0"])
   s.add_runtime_dependency(%q<instrumental_agent>, [">=0.5"])
+  s.add_runtime_dependency(%q<pidly>, [">=0.1.3"])
   s.add_development_dependency(%q<rake>, [">=0"])
 end

data/lib/instrumental_tools/version.rb

@@ -1,5 +1,5 @@
 module Instrumental
   module Tools
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instrumental_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000 Z
+date: 2011-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70216156656220 !ruby/object:Gem::Requirement
+  requirement: &70316651665940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70216156656220
+  version_requirements: *70316651665940
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
-  requirement: &70216156655680 !ruby/object:Gem::Requirement
+  requirement: &70316651665420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,21 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70216156655680
+  version_requirements: *70316651665420
+- !ruby/object:Gem::Dependency
+  name: pidly
+  requirement: &70316651664940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70316651664940
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70216156655080 !ruby/object:Gem::Requirement
+  requirement: &70316651664460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,7 +57,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70216156655080
+  version_requirements: *70316651664460
 description: Tools for displaying information from and reporting to Instrumental (instrumentalapp.com)
 email:
 - support@instrumentalapp.com
@@ -86,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Command line tools for Instrumental