instrumentation

OpenTelemetry instrumentation libraries

OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.

Instrumentation libraries provide pre-built OpenTelemetry instrumentation for popular libraries: Examples include Rails, Rack, Sinatra, and others. This way you can start using OpenTelemetry with minimal changes to your application.

Which instrumentations already exist, and which are currently in progress?

Released instrumentations can be found at the OpenTelemetry registry. You can also look in this project's Github repository: Individual instrumentation libraries can be found in subdirectories under /instrumentation.

In-progress instrumentations can be found here.

How do I get started?

Individual instrumentation libraries

To get started with a single instrumentation library, for example opentelemetry-instrumentation-rack:

1. Install the gem

gem install opentelemetry-instrumentation-rack

2. Configure OpenTelemetry to use the instrumentation

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Rack'
end

Instrumentation-specific documentation can be found in each subdirectory's README.md.

opentelemetry-instrumentation-all

You also have the option of installing all of the instrumentation libraries by installing opentelemetry-instrumentation-all. See that gem's README for more.

Maintenance and Version Compatibility

We are a community of volunteers who do our best to provide our users with up to date support for instrumentations, however we have limited capacity and are unable to support compatibility with EOL or unmaintained libraries.

Should you need to instrument an older version of a library you will have to ensure to pin to an instrumentation version that is compatible with that library.

Please review the individual instrumentation READMEs for more information about version compatibility.

How can I get involved?

The source for all OpenTelemetry Ruby instrumentation gems is on github.

If you are interested in helping out with an instrumentation, you can see instrumentations that have been requested but are not currently in-progress here.

The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our GitHub Discussions, Slack Channel or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.

License

All OpenTelemetry Ruby instrumentation gems are distributed under the Apache 2.0 license. See LICENSE for more information.