Honeycomb Beeline for Ruby

OSS Lifecycle Build Status Gem Version

⚠️Note: Beelines are Honeycomb's legacy instrumentation libraries. We embrace OpenTelemetry as the effective way to instrument applications. For any new observability efforts, we recommend instrumenting with OpenTelemetry.

This package makes it easy to instrument your Ruby web app to send useful events to Honeycomb, a service for debugging your software in production.

Sign up for a Honeycomb trial to obtain an API key before starting.

Compatible with

Requires Ruby version 2.5 or later

Built in instrumentation for:

  • Active Support
  • AWS (v2 and v3)
  • Faraday
  • Rack
  • Rails (tested on versions 4.1 and up)
  • Redis (tested on versions 3.x and 4.x)
  • Sequel
  • Sinatra

Testing

Find rspec test files in the spec directory.

To run tests on gem-specific instrumentations or across various dependency versions, use appraisal (further instructions in the readme for that gem). Find gem sets in the Appraisals config.

To run a specific file: bundle exec appraisal <gem set> rspec <path/to/file>

Get in touch

Please reach out to [email protected] or ping us with the chat bubble on our website for any assistance. We also welcome bug reports.

Contributions

Features, bug fixes and other changes to beeline-ruby are gladly accepted. Please open issues or a pull request with your change. Remember to add your name to the CONTRIBUTORS file!

All contributions will be released under the Apache License 2.0.