README.md in instrumental_agent-0.12.1 vs README.md in instrumental_agent-0.12.2

- old
+ new

@@ -1,18 +1,18 @@ # Instrumental Agent -Instrument anything. +Measure your application in real time. ## Setup & Usage Add the gem to your Gemfile. ```sh gem 'instrumental_agent' ``` -Visit [instrumentalapp.com](instrumentalapp.com) and create an account, then initialize the agent with your API key, found in the Docs section. +Visit [instrumentalapp.com](https://instrumentalapp.com) and create an account, then initialize the agent with your API key, found in the Docs section. ```sh I = Instrumental::Agent.new('YOUR_API_KEY', :enabled => Rails.env.production?) ``` @@ -86,9 +86,11 @@ 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" ``` + +The default message sent is "USER deployed COMMIT_HASH". If you need to customize it, set a capistrano variable named `deploy_message` to the value you'd prefer. ## Tracking metrics in Resque jobs (and Resque-like scenarios) If you plan on tracking metrics in Resque jobs, you will need to explicitly cleanup after the agent when the jobs are finished. You can accomplish this by adding `after_perform` and `on_failure` hooks to your Resque jobs. See the Resque [hooks documentation](https://github.com/defunkt/resque/blob/master/docs/HOOKS.md) for more information.