OpenTelemetry Ruby Contrib

Contrib Packages for the OpenTelemetry Ruby API and SDK implementation.

• Getting Started
• Contributing
• Instrumentation Libraries
• Versioning
• Useful links
• License

Contributing

We’d love your help! Use tags good first issue and help wanted to get started with the project.

Please review the contribution instructions for important information on setting up your environment, running the tests, and opening pull requests.

The Ruby special interest group (SIG) meets regularly. See the OpenTelemetry community page repo for information on this and other language SIGs.

Approvers (@open-telemetry/ruby-contrib-approvers):

• Josef Šimánek
• Xuan Cao, Solarwinds

Find more about the approver role in community repository.

Maintainers (@open-telemetry/ruby-contrib-maintainers):

• Ariel Valentin, GitHub
• Daniel Azuma, Google
• Eric Mustin
• Francis Bogsanyi, Shopify
• Kayla Reopelle, New Relic
• Matthew Wear, Lightstep
• Robb Kidd, Honeycomb
• Robert Laurin, Shopify
• Sam Handler, Shopify

Find more about the maintainer role in community repository.

Instrumentation Libraries

This repository contains instrumentation libraries for many popular Ruby gems, including Rails, Rack, Sinatra, and others, so you can start using OpenTelemetry with minimal changes to your application. See the instrumentation README for more details.

Helpers

This repository also contains libraries that hold code shared among multiple instrumentation libraries.

• MySQL
• SQL Obfuscation

Additional Libraries

This repository also contains libraries to aid with interoperability with vendor specific tracing solutions:

• Context Propagation: OTTrace and Amazon X-Ray
• Resource Detectors:
  • Azure
  • Container
  • Google Cloud Platform

Versioning

OpenTelemetry Ruby follows the versioning and stability document in the OpenTelemetry specification. Notably, we adhere to the outlined version numbering exception, which states that experimental signals may have a 0.x version number.

Ruby and Library Compatibility

All libraries in this repository require Ruby Versions 3.1 or newer.

This project is managed on a volunteer basis and therefore we have limited capacity to support compatibility with unmaintained or EOL libraries.

We will regularly review the instrumentations to drop compatibility for any versions of Ruby or gems that reach EOL or no longer receive regular maintenance.

Should you need instrumentation for older versions of a library then you must pin to a specific version of the instrumentation that supports it, however, you will no longer receive any updates for the instrumentation from this repository.

When a release series is no longer supported, it’s your own responsibility to deal with bugs and security issues. We may provide backports of the fixes and publish them to git, however there will be no new versions released. If you are not comfortable maintaining your own versions, you should upgrade to a supported version. https://guides.rubyonrails.org/maintenance_policy.html#security-issues

Consult instrumentation gem’s README file and gemspec for details about library compatibility.

Releases

This repository was extracted from the OpenTelemetry Ruby repository. Versions of libraries contained in this repo released prior to 2022-06-13 are available on the OpenTelemetry Ruby Releases page. Newer versions are available here

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.