opentelemetry-instrumentation-que

Que Instrumentation

The Que instrumentation is a community-maintained instrumentation for the Que.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-que

Or, if you use bundler, include opentelemetry-instrumentation-que to your Gemfile.

Usage

To install the instrumentation, add the gem to your Gemfile:

gem 'opentelemetry-instrumentation-que'

Then call use with the name of the instrumentation:

require 'rubygems'
require 'bundler/setup'

Bundler.require

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

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

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

By default tracing information is propagated using Que Job tags. This can be disabled using:

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Que', propagation_style: :none
end

If you wish the job will be executed in the same logical trace as a direct child of the span that enqueued the job then set propagation_style to child. By default the jobs are just linked together.

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Que', propagation_style: :child
end

How can I get involved?

The opentelemetry-instrumentation-que 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.

Testing the gem locally

To install test dependencies run:

bundle exec appraisal

To run tests on all appraised Que versions, run:

bundle exec appraisal rake test

To run tests with a specific Que version, run:

bundle exec appraisal [que-version] rake test

All appraised Que versions can be found in the Appraisals file.

License

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