opentelemetry-instrumentation-redis

OpenTelemetry Redis Instrumentation

The OpenTelemetry Redis Ruby gem is a community maintained instrumentation for Redis. This is an in-memory data store that is used as a database, cache, and message broker.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-redis

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

Usage

To install the instrumentation, call use with the name of the instrumentation.

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Redis'
end

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

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

The Redis instrumentation allows the user to supply additional attributes via context propagation. This may be used to propagate attributes from instrumentation for things like Resque and Sidekiq, for example, to attach to the Redis client spans.

require 'opentelemetry/instrumentation/redis'

redis = ::Redis.new
OpenTelemetry::Instrumentation::Redis.with_attributes('peer.service' => 'cache') do
  redis.set('K', 'x')
end

### Configuration options

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Redis', {
    # The obfuscation of arguments in the db.statement attribute is enabled by default.
    # To include the full query, set db_statement to :include.
    # To obfuscate, set db_statement to :obfuscate.
    # To omit the attribute, set db_statement to :omit.
    db_statement: :include,
  }
end

Example

An example of usage can be seen in example/redis.rb.

Development

You'll need Redis installed locally to run the test suite. Once you've installed it, it will start and stop automatically when you run rake.

How can I get involved?

The opentelemetry-instrumentation-redis 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 in GitHub Discussions 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

Apache 2.0 license. See LICENSE for more information.