opentelemetry-instrumentation-sidekiq

OpenTelemetry Sidekiq Instrumentation

The Sidekiq instrumentation is a community-maintained instrumentation for the Sidekiq Ruby jobs system.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-sidekiq

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

Usage

To use the instrumentation, call use with the name of the instrumentation:

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

Alternatively, you can also call use_all to install all the available instrumentation.

OpenTelemetry::SDK.configure do |c|
  c.use_all
end

Examples

Example usage can be seen in the ./example/sidekiq.rb file here

Development

You'll need Redis installed locally to run the test suite. Once you've installed it, it will start and stop automatically when you run rake.

redis-server test/redis.conf

How can I get involved?

The opentelemetry-instrumentation-sidekiq 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-sidekiq gem is distributed under the Apache 2.0 license. See LICENSE for more information.