OpenTelemetry AWS-SDK Instrumentation
The OpenTelemetry aws-sdk
gem is a community maintained instrumentation for aws-sdk-ruby.
How do I get started?
Install the gem using:
gem install opentelemetry-instrumentation-aws_sdk
Or, if you use bundler, include opentelemetry-instrumentation-aws_sdk
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::AwsSdk', {
inject_messaging_context: true,
suppress_internal_instrumentation: true
}
end
Alternatively, you can also call use_all
to install all the available instrumentation.
OpenTelemetry::SDK.configure do |c|
c.use_all
end
Example
To run the example:
cd
to the examples directory and install gemscd example
bundle install
- Run the sample client script
ruby trace_demonstration.rb
This will run SNS publish command, printing OpenTelemetry traces to the console as it goes.
How can I get involved?
The opentelemetry-instrumentation-aws_sdk
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.