README.md in instrumental_agent-0.6.1 vs README.md in instrumental_agent-0.7
- old
+ new
@@ -32,10 +32,18 @@
**Note**: For your app's safety, the agent is meant to isolate your app
from any problems our service might suffer. If it is unable to connect
to the service, it will discard data after reaching a low memory
threshold.
+Want to track an event (like an application deploy, or downtime)? You can capture events that
+are instantaneous, or events that happen over a period of time.
+
+```sh
+I.notice('Jeffy deployed rev ef3d6a') # instantaneous event
+I.notice('Testing socket buffer increase', 3.days.ago, 20.minutes) # an event with a duration
+```
+
## Backfilling
Streaming data is better with a little historical context. Instrumental
lets you backfill data, allowing you to see deep into your project's
past.
@@ -54,31 +62,40 @@
User.find_each do |user|
I.increment('signups', 1, user.created_at)
end
```
-## Server stats
+## Server Stats
Want some general server stats (load, memory, etc.)? Check out the
[instrumental_tools](https://github.com/fastestforward/instrumental_tools)
gem.
```sh
gem install instrumental_tools
instrument_server
```
-## Rack middleware
+## Agent Control
-Running under Rails? You can also give our experimental Rack middleware
-a shot by initializing it with:
-
-```sh
-Instrumental::Middleware.boot
-```
-
Need to quickly disable the agent? set :enabled to false on
initialization and you don't need to change any application code.
+
+
+## Capistrano Integration
+
+Add `require "instrumental/capistrano"` to your capistrano configuration
+and your deploys will be tracked automatically by Instrumental.
+
+The following configuration will be added:
+
+```ruby
+before "deploy", "instrumental:util:deploy_start"
+after "deploy", "instrumental:util:deploy_end"
+before "deploy:migrations", "instrumental:util:deploy_start"
+after "deploy:migrations", "instrumental:util:deploy_end"
+after "instrumental:util:deploy_end", "instrumental:record_deploy_notice"
+```
## Troubleshooting & Help
We are here to help, please email us at
[support@instrumentalapp.com](mailto:support@instrumentalapp.com).