Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding README for Sidekiq instrumentation #386

Merged
merged 3 commits into from
Sep 17, 2020
Merged

Adding README for Sidekiq instrumentation #386

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68ab108
adding README for sidekiq instrumentation
Sep 16, 2020
ba9363f
adding Examples section in sidekiq README
Sep 17, 2020
4599840
Merge branch 'master' into 241-add-documentation-for-sidekiq
Sep 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions instrumentation/sidekiq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# OpenTelemetry Sidekiq Instrumentation

The Sidekiq instrumentation is a community-maintained instrumentation for the [Sidekiq][sidekiq-home] Ruby jobs system.

## How do I get started?

Install the gem using:

```
gem install opentelemetry-instrumentation-sidekiq
```

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

## Usage

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

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

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

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

## How can I get invovled?

The `opentelemetry-instrumentation-sidekiq` 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 [gitter channel][ruby-gitter] 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].

## License

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

[sidekiq-home]: https:/mperham/sidekiq
[bundler-home]: https://bundler.io
[bundler-home]: https://bundler.io
AzfaarQureshi marked this conversation as resolved.
Show resolved Hide resolved
Comment on lines +47 to +48
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bundler-home listed twice. Everything looks great.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching that - it was a problem in another PR too, but I was lulled into ignorance after reviewing a few that didn't have that problem.

[repo-github]: https:/open-telemetry/opentelemetry-ruby
[license-github]: https:/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
[ruby-sig]: https:/open-telemetry/community#ruby-sig
[community-meetings]: https:/open-telemetry/community#community-meetings
[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby