Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iaintshine/ruby-sidekiq-tracer
OpenTracing instrumentation for Sidekiq
https://github.com/iaintshine/ruby-sidekiq-tracer
opentracing ruby sidekiq tracing
Last synced: 3 months ago
JSON representation
OpenTracing instrumentation for Sidekiq
- Host: GitHub
- URL: https://github.com/iaintshine/ruby-sidekiq-tracer
- Owner: iaintshine
- License: apache-2.0
- Created: 2017-09-10T22:51:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T21:08:29.000Z (about 2 years ago)
- Last Synced: 2024-10-10T04:27:38.557Z (3 months ago)
- Topics: opentracing, ruby, sidekiq, tracing
- Language: Ruby
- Size: 19.5 KB
- Stars: 8
- Watchers: 1
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Sidekiq::Tracer
OpenTracing instrumentation for Sidekiq (both client, and server-side).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sidekiq-opentracing'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install sidekiq-opentracing
## Usage
The gem hooks up into Sidekiq through [middlewares](https://github.com/mperham/sidekiq/wiki/Middleware) - similar to Rack. Both server-side, and client-side middlewares are supported.
* Client-side middleware runs before the pushing of the job to Redis and injects the current span context into the job's metadata.
* Server-side runs around job processing, extracts the context from the job metadata and creates a new span for the server-side proessing.
To instrument Sidekiq (both sides), you need to specify at least a tracer instance and optionally an active span provider - a proc which returns a current active span. The gem plays nicely with [spanmanager](https://github.com/iaintshine/ruby-spanmanager).
```ruby
require "sidekiq-opentracing"
Sidekiq::Tracer.instrument(tracer: OpenTracing.global_tracer,
active_span: -> { OpenTracing.global_tracer.active_span })
```
And you are all set.
The code below shows how to register and manage middlewares on your own.
Server-side:
```ruby
Sidekiq.configure_server do |config|
config.client_middleware do |chain|
chain.add Sidekiq::Tracer::ClientMiddleware, tracer: OpenTracing.global_tracer
end
config.server_middleware do |chain|
chain.add Sidekiq::Tracer::ServerMiddleware, tracer: OpenTracing.global_tracer
end
end
```
Client-side:
```ruby
Sidekiq.configure_client do |config|
config.client_middleware do |chain|
chain.add Sidekiq::Tracer::ClientMiddleware, tracer: OpenTracing.global_tracer
end
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/iaintshine/ruby-sidekiq-tracer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Code of Conduct
Everyone interacting in the Sidekiq::Tracer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iaintshine/ruby-sidekiq-tracer/blob/master/CODE_OF_CONDUCT.md).