OpenTelemetry Registry Instrumentation

The instrumentation Registry contains information about available instrumentation, facilitates discovery, installation, and configuration.

The Registry allows for instrumentation to avoid depending directly on a specific SDK implementation.

The SDK depends on the Registry, the instrumentation Base class depends on the Registry, and auto instrumentation libraries extend the instrumentation Base class.

The motivation for decoupling the Registry (and by extension the instrumentation) from a specific SDK implementation means that anyone can implement their own OpenTelemetry API compatible SDK, and they could continue to use community made instrumentation.

How do I get started?

Install the gem using:

gem install opentelemetry-registry

Or, if you use bundler, include opentelemetry-registry in your Gemfile.

  gem 'opentelemetry-registry'

How can I get involved?

The opentelemetry-registry gem source is on github, along with related gems including opentelemetry-api and opentelemetry-sdk.

The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in GitHub Discussions 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

The opentelemetry-instrumentation-registry gem is distributed under the Apache 2.0 license. See LICENSE for more information.