sidekiq-opentsdb

Sidekiq::Opentsdb

Sidekiq middleware that sends useful Sidekiq statistics to OpenTSDB.

Installation

Add this line to your application's Gemfile:

gem 'sidekiq-opentsdb'

And then execute:

$ bundle

Usage

You need to add the middleware to your call stack. To do so, put the folllowing code in an initializer (ideally sidekiq.rb):

Sidekiq.configure_server do |config|
  config.server_middleware do |chain|
    middleware_options = {
      opentsdb_hostname: 'localhost',
      opentsdb_port: '4242',
      metric_prefix: 'nine',
      only: %w(retry_size dead_size)
    }

    chain.add Sidekiq::Opentsdb::ServerMiddleware, middleware_options
  end
end

Available Options

opentsdb_hostname: 'localhost'   # (required) Hostname of your opentsdb server.
opentsdb_port: '4242'            # (required) Port of your opentsdb server.

metric_prefix: 'nine'            # (optional) Prefix of the metric keys (default: '').
only:   %w(retry_size dead_size) # (optional) Only send the given metrics to OpenTSDB.
except: %w(retry_size dead_size) # (optional) Send all but the given metrics to OpenTSDB.

# Tags
app: 'MyApp'                     # (optional) Your app name (Rails app name if available)
environment: 'staging'           # (optional) Your app environment (default: ENV['RACK_ENV'])

About

This Gem is maintained and funded by nine.ch.

We run your Linux server infrastructure – without interruptions, around the clock.