opentelemetry-instrumentation-all

The opentelemetry-instrumentation-all gem is an all-in-one distribution of community maintained instrumentation. Instrumentation libraries are packaged as individual gems for flexibility and maintainability. Instead of having to require each instrumentation individually, applications can depend on this all-in-one gem as a convenient alternative.

What is OpenTelemetry?

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.

OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.

How does this gem fit in?

This gem can be used with any OpenTelemetry SDK implementation. This can be the official opentelemetry-sdk gem or any other concrete implementation.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-all

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

The opentelemetry-api has functionality to discover the instrumentation that an application depends on. It maintains a registry of discovered instrumentation which can be automatically installed by the SDK. These instructions pertain to the official opentelemetry-sdk implementation. Consult the documentation for your SDK if you are using an alternative implementation.

Use All

The use_all method will install all instrumentation present for an application, where the underlying, instrumented library is also present. Per library configuration can be passed in using an optional hash argument that has the instrumentation names as keys and configuration hashes as values.

require 'opentelemetry/sdk'

# install all compatible instrumentation with default configuration
OpenTelemetry::SDK.configure do |c|
  c.use_all
end

require 'opentelemetry/sdk'

# install all compatible instrumentation with per instrumentation configuration overrides
OpenTelemetry::SDK.configure do |c|
  c.use_all('OpenTelemetry::Instrumentation::SomeInstrumentation' => { opt: 'value' })
end

Selective Install

Some users may want more fine grained control over what instrumentation they install for their application. Users can opt to selectively install instrumentation with the use method. Call use with the name of the instrumentation, and an optional configuration hash.

require 'opentelemetry/sdk'

# install all compatible instrumentation with default configuration
OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Sinatra'
  c.use 'OpenTelemetry::Instrumentation::SomeInstrumentation', { opt: 'value' }
end

Releasing

Releasing opentelemetry-instrumentation-all requires that all gems it depends on exist on rubygems.org before publishing it. Because of this, it must be the last gem to be published in the release process.

How can I get involved?

The opentelemetry-instrumentation-all 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 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

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