instrumental_tools 0.4.2 → 0.5.0

data/README.md

@@ -1,10 +1,12 @@
 # Instrumental Tools
 
-A collection of scripts useful in monitoring servers and services with Instrumental ([www.instrumentalapp.com](http://www.instrumentalapp.com/)).
+A collection of scripts useful for monitoring servers and services with Instrumental ([www.instrumentalapp.com](http://www.instrumentalapp.com/)).
 
 ## instrument_server
 
-Use to monitor server activity by collecting information on CPU and memory usage, disk IO, filesystem usage, etc. Execute with:
+Monitor server activity by collecting information on CPU and memory usage, disk IO, filesystem usage, etc.
+
+Basic usage:
 
 ```sh
 instrument_server -k <API_KEY>
@@ -12,23 +14,29 @@ instrument_server -k <API_KEY>
 
 The API key can also be provided by setting the INSTRUMENTAL_TOKEN environment variable, which eliminates the need to supply the key via command line option.
 
-NOTE for Mac OS users: Due to a bug in Ruby, instrument_server can occasionally deadlock ([bug report](http://bugs.ruby-lang.org/issues/5811)).
+By default, instrument_server will use the hostname of the current host when reporting metrics, e.g. 'hostname.cpu.in_use'. To specify a different hostname:
 
-## instrumental
+```sh
+instrument_server -k <API_KEY> -H <HOSTNAME>
+```
 
-Output text graphs of the different metrics in your project.
+### Running as a Daemon
 
-See all options with: `instrumental --help`
+To start instrument_server as a daemon:
 
-## gitstrumental
+```
+instrument_server -k <API_KEY> -d
+```
 
-Collect statistics on commit counts in a given git repo.  Execute in the repo directory with:
+While the -d flag alone is sufficient for starting instrument_server as a daemon, use of additional parameters allows interaction with the running daemon process:
+
+* start, stop, restart - run, halt, or restart the daemon
+* status - display daemon status (running, stopped)
+* clean - remove any files created by the daemon
+* kill - forcibly halt the daemon and remove its pid file
 
-```sh
-gitstrumental [API_KEY]
-```
 
-## Capistrano Integration
+### Capistrano Integration
 
 Add `require "instrumental_tools/capistrano"` to your capistrano
 configuration and instrument_server will be restarted after your
@@ -54,3 +62,16 @@ something like this in your capistrano configuration:
 ```ruby
 namespaces[:instrumental].tasks[:restart_instrument_server].options[:roles] = [:web, :worker]
 ```
+
+### NOTEs
+
+Mac OS users: Due to a bug in Ruby, instrument_server can occasionally deadlock ([bug report](http://bugs.ruby-lang.org/issues/5811)).
+
+## gitstrumental
+
+Collect commit counts from git repositories:
+
+```sh
+cd project_directory
+gitstrumental <API_KEY>
+```

data/bin/gitstrumental

@@ -6,7 +6,7 @@ require 'instrumental_agent'
 token = ENV["INSTRUMENTAL_TOKEN"] || ARGV[0]
 
 if !token 
-  puts 'Usage: gitstrumental API_TOKEN'
+  puts 'Usage: gitstrumental API_KEY'
   exit 1
 end
 

data/instrumental_tools.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.email       = ["support@instrumentalapp.com"]
   s.homepage    = "http://github.com/fastestforward/instrumental_tools"
   s.summary     = %q{Command line tools for Instrumental}
-  s.description = %q{Tools for displaying information from and reporting to Instrumental (instrumentalapp.com)}
+  s.description = %q{A collection of scripts useful for monitoring servers and services with Instrumental (instrumentalapp.com)}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/instrumental_tools/version.rb

@@ -1,5 +1,5 @@
 module Instrumental
   module Tools
-    VERSION = '0.4.2'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,15 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: instrumental_tools
-version: !ruby/object:Gem::Version 
-  hash: 11
+version: !ruby/object:Gem::Version
+  version: 0.5.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 2
-  version: 0.4.2
 platform: ruby
-authors: 
+authors:
 - Elijah Miller
 - Christopher Zelenak
 - Kristopher Chambers
@@ -17,122 +12,93 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70357022830140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: instrumental_agent
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70357022830140
+- !ruby/object:Gem::Dependency
+  name: instrumental_agent
+  requirement: &70357022829620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 5
-        version: "0.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: pidly
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70357022829620
+- !ruby/object:Gem::Dependency
+  name: pidly
+  requirement: &70357022829140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 0
-        - 1
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.3
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70357022829140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70357022828660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: Tools for displaying information from and reporting to Instrumental (instrumentalapp.com)
-email: 
+  prerelease: false
+  version_requirements: *70357022828660
+description: A collection of scripts useful for monitoring servers and services with
+  Instrumental (instrumentalapp.com)
+email:
 - support@instrumentalapp.com
-executables: 
+executables:
 - gitstrumental
 - instrument_server
-- instrumental
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
 - Rakefile
 - bin/gitstrumental
 - bin/instrument_server
-- bin/instrumental
 - instrumental_tools.gemspec
 - lib/instrumental_tools/capistrano.rb
 - lib/instrumental_tools/version.rb
 homepage: http://github.com/fastestforward/instrumental_tools
 licenses: []
-
 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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Command line tools for Instrumental
 test_files: []
-

data/bin/instrumental

@@ -1,54 +0,0 @@
-#!/usr/bin/env ruby
-require 'cgi'
-require 'net/http'
-require 'optparse'
-require 'rubygems'
-gem 'json'
-require 'json'
-
-
-metrics = "*"
-token = ENV["INSTRUMENTAL_TOKEN"]
-allowed_durations = [1800, 3600, 10800, 21600, 43200, 86400, 259200, 604800, 1209600]
-duration = nil
-
-opts = OptionParser.new do |opts|
-  opts.banner = "Usage: instrumental [options]"
-
-  opts.on("-m", "--metrics METRICS", "Comma separated list of metrics you're interested in.  Wildcard (*) allowed") do |m|
-    metrics = m
-  end
-
-  opts.on("-t", "--token TOKEN", "Your API token.  Also can be set as an environment variable, INSTRUMENTAL_TOKEN") do |t|
-    token = t
-  end
-
-  opts.on("-d", "--duration DURATION", "Duration ago in seconds to view.  You can specify #{allowed_durations.join(" ")}") do |d|
-    duration = allowed_durations.index(d.to_i) && d.to_i
-  end
-end.parse!
-
-search_line = CGI.escape(metrics)
-duration &&= "&duration=#{duration}"
-http = Net::HTTP.new("instrumentalapp.com", 80)
-request = Net::HTTP::Get.new("/metrics/#{search_line}?token=#{token}&format=json#{duration}")
-response = http.request(request)
-raise "Server error: #{response.message} #{response.code}" if response.code.to_i != 200
-response = JSON.parse(response.body)
-bars = ["\342\226\201", "\342\226\202", "\342\226\203", "\342\226\204", "\342\226\205", "\342\226\206", "\342\226\207"]
-max_key_size = response.collect { |k, v| k.size }.max
-scale = bars.size - 1
-response.each do |metric, data|
-  data = data.collect { |h| h["value"].to_f }
-  min = data.min
-  range = data.max - min
-  graph = data.collect do |v|
-    if (idx = (((v - min) / range) * scale)).nan?
-      idx = 0
-    elsif idx.infinite?
-      idx = scale
-    end
-    bars[idx.round]
-  end
-  puts "%#{max_key_size}s | %s" % [metric, graph.join]
-end