# Que Instrumentation

The Que instrumentation is a community-maintained instrumentation for the [Que][que-home].

## How do I get started?

Install the gem using:

```console
gem install opentelemetry-instrumentation-que
```

Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-que` to your `Gemfile`.

## Usage

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

```ruby
gem 'opentelemetry-instrumentation-que'
```

Then call `use` with the name of the instrumentation:

```ruby
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.

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

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

```ruby
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.

```ruby
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][repo-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][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].

## Testing the gem locally

To install test dependencies run:

```console
bundle exec appraisal
```

To run tests on all appraised Que versions, run:

```console
bundle exec appraisal rake test
```

To run tests with a specific Que version, run:

```console
bundle exec appraisal [que-version] rake test
```

All appraised Que versions can be found in the [Appraisals][appraisal-file] file.

## License

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

[que-home]: https://github.com/que-rb/que
[bundler-home]: https://bundler.io
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
[appraisal-file]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/que/Appraisals