README.md

heroku-buildpack-sidekiq-metrics

This Heroku buildpack provides sidekiq metrics.

See also https://github.com/mperham/sidekiq/wiki/Monitoring

How does it affect my slug?

This buildpack does two things:

1. Copies .profile.d/ruby-sidekiq-metrics.sh script into your slug
   • See also Dynos and the Dyno Manager > Startup > The .profile file
2. Copies sidekiq-metrics script into your slug

The .profile.d/ruby-sidekiq-metrics.sh script starts the sidekiq-metrics script on web.1 Dyno boot.

The sidekiq-metrics script is called every 30 seconds and outputs the following log to stdout that is compatible with Librato Custom log-based metrics:

sample#sidekiq.default.size=0 sample#sidekiq.mailer.size=0
sample#sidekiq.default.latency=0 sample#sidekiq.mailer.latency=0

Requirements

• bundler
• heroku/ruby buildpack
• sidekiq

Customize

• SIDEKIQ_METRICS_DYNO (Default: web.1)
  • The Dyno name which the sidekiq-metrics script boot as daemon
• SIDEKIQ_METRICS_INTERVAL (Default: 30)
  • Polling interval (seconds) which the sidekiq-metrics script is called
• SIDEKIQ_METRICS_TYPE (Default: sample)
  • You can set sample or measure. Although you can set count, it would not make sense for sidekiq metrics
  • See also Librato Custom log-based metrics

Configure from CLI

$ heroku buildpacks:add https://github.com/feedforce/heroku-buildpack-sidekiq-metrics.git

Configure from app manifest

{
  "buildpacks": [
    {
      "url": "https://github.com/feedforce/heroku-buildpack-sidekiq-metrics.git"
    }
  ]
}