puma-plugin-telemetry

Puma::Plugin::Telemetry

Puma plugin which should be able to handle all your metric needs regarding your webserver:

• ability to publish basic puma statistics (like queue backlog) to both logs and Datadog
• ability to add custom target whenever you need it
• ability to monitor puma socket listen queue (!)
• ability to report requests queue time via custom rack middleware - the time request spent between being accepted by Load Balancer and start of its processing by Puma worker

Install

Add this line to your application's Gemfile:

gem "puma-plugin-telemetry"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install puma-plugin-telemetry

Usage

In your puma configuration file (i.e. config/puma.rb or config/puma/<env>.rb):

plugin "telemetry"

Puma::Plugin::Telemetry.configure do |config|
  config.enabled = true

  # << here rest of the configuration, examples below
end

Basic

Output telemetry as JSON to STDOUT

  config.add_target :io

Datadog StatsD target

Given gem provides built in target for Datadog StatsD client, that uses batch operation to publish metrics.

NOTE Be sure to have dogstatsd gem installed.

  config.add_target :dogstatsd, client: Datadog::Statsd.new

You can provide all the tags, namespaces, and other configuration options as always to Datadog::Statsd.new method.

All available options

For detailed documentation checkout Puma::Plugin::Telemetry::Config class.

Puma::Plugin::Telemetry.configure do |config|
  config.enabled = true
  config.initial_delay = 10
  config.frequency = 30
  config.puma_telemetry = %w[workers.requests_count queue.backlog queue.capacity]
  config.socket_telemetry!
  config.socket_parser = :inspect
  config.add_target :io, formatter: :json, io: StringIO.new
  config.add_target :dogstatsd, client: Datadog::Statsd.new(tags: { env: ENV["RAILS_ENV"] })
end

Custom Targets

Target is a simple object that implements call methods that accepts telemetry hash object. This means it can be super simple proc or some sophisticated class calling some external API.

Just be mindful that if the API takes long to call, it will slow down frequency with which telemetry will get reported.

  # Example logfmt to stdout target
  config.add_target proc { |telemetry| puts telemetry.map { |k, v| "#{k}=#{v.inspect}" }.join(" ") }

Extra middleware

This gems comes together with middleware for measuring request queue time, which will be reported in request.env and published to given StatsD client.

Example configuration:

# in Gemfile add `require` part
gem "puma-plugin-telemetry", require: ["rack/request_queue_time_middleware"]

# in initializer, i.e. `request_queue_time.rb`
Rails.application.config.middleware.insert_after(
  0,
  RequestQueueTimeMiddleware,
  statsd: Datadog::Statsd.new(namespace: "ruby.puma", tags: { "app" => "accounts" })
)

Rails.application.config.log_tags ||= {}
Rails.application.config.log_tags[:queue_time] = ->(req) { req.env[::RequestQueueTimeMiddleware::ENV_KEY] }

This will provide proper metric in Datadog and in logs as well. Logs can be transformed into log metrics and used for auto scaling purposes.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec 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.

Release

All gem releases are manual, in order to create a new release follow:

1. Create new PR (this could be included in feature PR, if it's meant to be released)
   • update VERSION, we use Semantic Versioning
   • update CHANGELOG
   • merge
2. Draft new release via Github Releases
   • use v#{VERSION} as a tag, i.e. v0.1.0
   • add release notes based on the Changelog
   • create
3. Gem will get automatically published to given rubygems server

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/babbel/puma-plugin-telemetry.

License

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

Code of Conduct

Everyone interacting in the puma-plugin-telemetry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.