OpenTelemetry Racecar Instrumentation

The Racecar instrumentation is a community-maintained instrumentation for Racecar, a client library for Apache Kafka.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-racecar

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

Runtime requirements

This instrumentation is built on top of Racecar's integration with ActiveSupport::Notifications. ActiveSupport::Notification will need to be loaded before the instrumentation is installed (as below) or the installation will cancel.

Usage

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

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Racecar'
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 directory. Run ./trace_demonstration.sh to see its behavior.

How can I get involved?

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

License

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