instrumental_tools 0.4.0 → 0.4.1

data/README.md

@@ -1,16 +1,18 @@
 # Instrumental Tools
 
-A collection of tools for use with Instrumental ([www.instrumental.com](http://www.instrumentalapp.com/))
+A collection of scripts useful in monitoring servers and services with Instrumental ([www.instrumentalapp.com](http://www.instrumentalapp.com/)).
 
 ## instrument_server
 
-Use to collect various monitoring statistics of a server. Execute with:
+Use to monitor server activity by collecting information on CPU and memory usage, disk IO, filesystem usage, etc. Execute with:
 
 ```sh
-instrument_server -k <INSTRUMENTAL_API_KEY>
+instrument_server -k <API_KEY>
 ```
 
-Mac OS note: Due to a bug in Ruby, instrument_server can occasionally deadlock ([bug report](http://bugs.ruby-lang.org/issues/5811)).
+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)).
 
 ## instrumental
 
@@ -23,7 +25,7 @@ See all options with: `instrumental --help`
 Collect statistics on commit counts in a given git repo.  Execute in the repo directory with:
 
 ```sh
-gitstrumental [INSTRUMENTAL_API_KEY]
+gitstrumental [API_KEY]
 ```
 
 ## Capistrano Integration
@@ -34,7 +36,7 @@ deploy is finished. Additionally, you will need to add a new variable
 to your capistrano file.
 
 ```ruby
-set :instrumental_key, "YOUR_KEY_HERE"
+set :instrumental_key, "API_KEY"
 ```
 
 The following configuration will be added:

data/bin/instrument_server

@@ -352,10 +352,7 @@ options = {
 }
 
 option_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: instrument_server [-k API_KEY] [options] [-d #{ServerController::COMMANDS.join('|')}]"
-  opts.on('-H', '--hostname HOSTNAME', 'Hostname to report as') do |hostname|
-    options[:hostname] = hostname
-  end
+  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
@@ -364,6 +361,9 @@ option_parser = OptionParser.new do |opts|
     options[:collector] = address
     options[:port] = port if port
   end
+  opts.on('-H', '--hostname HOSTNAME', "Hostname to report as (default #{options[:hostname]})") do |hostname|
+    options[:hostname] = hostname
+  end
   opts.on('-d', '--daemonize', 'Run as daemon') do
     options[:daemon] = true
   end

data/lib/instrumental_tools/version.rb

@@ -1,5 +1,5 @@
 module Instrumental
   module Tools
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instrumental_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -16,7 +16,7 @@ date: 2012-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70277493718520 !ruby/object:Gem::Requirement
+  requirement: &70127299346760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70277493718520
+  version_requirements: *70127299346760
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
-  requirement: &70277493718000 !ruby/object:Gem::Requirement
+  requirement: &70127299344700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70277493718000
+  version_requirements: *70127299344700
 - !ruby/object:Gem::Dependency
   name: pidly
-  requirement: &70277493717520 !ruby/object:Gem::Requirement
+  requirement: &70127299342960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70277493717520
+  version_requirements: *70127299342960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70277493717040 !ruby/object:Gem::Requirement
+  requirement: &70127299357440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,7 +57,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277493717040
+  version_requirements: *70127299357440
 description: Tools for displaying information from and reporting to Instrumental (instrumentalapp.com)
 email:
 - support@instrumentalapp.com