OpenTelemetry Mongo Instrumentation
The OpenTelemetry Mongo Ruby gem is a community maintained instrumentation for Mongo.
How do I get started?
Install the gem using:
gem install opentelemetry-instrumentation-mongo
Or, if you use bundler, include opentelemetry-instrumentation-mongo
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::Mongo'
end
Alternatively, you can also call use_all
to install all the available instrumentation.
OpenTelemetry::SDK.configure do |c|
c.use_all
end
Configuration options
OpenTelemetry::SDK.configure do |c|
c.use 'OpenTelemetry::Instrumentation::Mongo', {
# Sets how db_statement appears in your traces. The options are:
# :obfuscate - (default) query parameters are visible, but values are masked.
# :include - query parameters and values are both fully visible.
# :omit - db_statement is omitted entirely.
db_statement: :include,
}
end
Example
To run the example:
- Start MongoDB using docker-compose
docker-compose up mongo
- In a separate terminal window,
cd
to the examples directory and install gemscd example
bundle install
- Run the sample client script
ruby mongo.rb
This will run a few MongoDB commands, printing OpenTelemetry traces to the console as it goes.
How can I get involved?
The opentelemetry-instrumentation-mongo
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
Apache 2.0 license. See LICENSE for more information.