README.md in instrumental_tools-0.4.0 vs README.md in instrumental_tools-0.4.1
- old
+ new
@@ -1,19 +1,21 @@
# 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
Output text graphs of the different metrics in your project.
See all options with: `instrumental --help`
@@ -21,21 +23,21 @@
## gitstrumental
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
Add `require "instrumental_tools/capistrano"` to your capistrano
configuration and instrument_server will be restarted after your
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:
```ruby