OpenTelemetry RubyKafka Instrumentation

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

Important

Deprecation Notice: This gem is deprecated due to the upstream dependency it relies on no longer being maintained. The code remains available for reference, but no further updates or fixes will be provided. Users should consider migrating to actively supported alternatives.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-ruby_kafka

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

Usage

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

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::RubyKafka'
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/ruby_kafka.rb file

How can I get involved?

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

Running Tests

Tests in this package require a running instance of Kafka and Zookeeper, which are made available via docker-compose:

ruby-kafka $> docker-compose up -d kafka
 Creating network "ruby_kafka_default" with the default driver
 Creating ruby_kafka_zookeeper_1 ... done
 Creating ruby_kafka_kafka_1     ... done

The run tests using rake

ruby-kafka $> bundle exec rake test

To stop the dependent services

ruby-kafka $> docker-compose down

License

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