Pliny Librato

A Librato metrics reporter backend for pliny.

This backend will push reported metrics onto a queue, then periodically submit them asynchronously.

Add this line to your application's Gemfile:

gem "pliny-librato"

And then execute:

$ bundle

Or install it yourself as:

$ gem install pliny-librato

Update (or add) your metrics initializer config/initializers/metrics.rb with:

if Config.librato_email && Config.librato_key
  Librato::Metrics.authenticate(Config.librato_email, Config.librato_key)
  Pliny::Metrics.backends = [Pliny::Librato::Metrics::Backend.new(
    source: "#{Config.app_name}.#{Config.app_env}",
    interval: 30
  ).tap(&:start)]
else
  Pliny::Metrics.backends = [Pliny::Metrics::Backends::Logger]
end

Now Pliny::Metrics methods will build a queue and automatically send metrics to Librato.

Pliny::Metrics.count(:foo, 3)
Pliny::Metrics.measure(:bar) do
  # Some stuff you want to time
end

By default, it will send queued metrics every minute, but can be configured on initialization.

By default, any unsubmitted metrics on the queue will not be sent at shutdown. It is the responsibility of the caller to trigger this.

Note: #stop will not work with signal traps, as mutexes can't be obtained within traps.

# In the main process
Kernel.at_exit do
  librato_backend.stop
end

# e.g. in Puma
on_worker_shutdown do
  librato_backend.stop
end

# e.g. in Sidekiq
Sidekiq.configure_server do |config|
  config.on(:shutdown) do
    librato_backend.stop
  end
end

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/heroku/pliny-librato.