Capistrano::Mackerel
Mackerel integration for Capistrano v3.
Features
- Measure processing time of capistrano tasks (e.g.
deploy
) and create graph annotation on Mackerel
Installation
Add this line to your application's Gemfile:
group :development do
gem 'capistrano-mackerel', require: false
end
Run the following command to install the gems:
bundle install
Usage
Require the library in your application's Capfile
:
require 'capistrano/mackerel'
Then set parameters in deploy.rb
.
# Required parameters
set :mackerel_service, 'your_service'
set :mackerel_roles, ['your_role']
set :mackerel_api_key, 'YOUR_MACKEREL_API_KEY'
# Specify tasks that will be measured its processing time
# Default value is ['deploy']
set :mackerel_annotate_tasks, ['your:task']
Development
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/questbeat/capistrano-mackerel.
License
The gem is available as open source under the terms of the MIT License.