Sidekiq::Datadog::Monitor

Library that gather sidekiq jobs metrics (currently, only size and latency) and send it to datadog

Installation

Add this line to your application's Gemfile:

gem 'sidekiq-datadog-monitor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sidekiq-datadog-monitor

Usage

To start sending metrics

# Import the library
require 'sidekiq/datadog/monitor'

# Configure Sidekiq::Datadog::Monitor.
Sidekiq::Datadog::Monitor.configure!(
  agent_host: 'localhost',
  agent_port: 8125,
  tags: ['env:production', 'product:product_name'], # optional
)
  • agent_host and agent_port instantiate DogStatsD client
  • tags additional tags to be added for every metrics

How it works

Gem using sidekiq lifecycle events to operate and send metrics to datadog. Heartbeat event is used to send metrics every 5 seconds. Heartbeat event happens in every sidekiq process so metrics will be sent multiple times but will be aggregated on datadog.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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/[USERNAME]/sidekiq-datadog-monitor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Sidekiq::Datadog::Monitor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.