The opentelemetry-propagator-xray gem contains injectors and extractors for the AWS XRay propagation format.

What is OpenTelemetry?

OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.

OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.

How does this gem fit in?

This gem can be used with any OpenTelemetry SDK implementation. This can be the official opentelemetry-sdk gem or any other concrete implementation.

How do I get started?

Install the gem using:

gem install opentelemetry-propagator-xray

Or, if you use bundler, include opentelemetry-propagator-xray in your Gemfile.

In your application:

require 'opentelemetry/propagator/xray'
# Optional
ENV['OTEL_PROPAGATORS'] ||= 'xray' # Or you can set this as an environment variable outside of the application

To generate AWS XRay compliant IDs use the 'OpenTelemetry::AWSXRayTrace' module:

require 'opentelemetry/propagator/xray'

OpenTelemetry::SDK.configure do |c|
  c.id_generator = OpenTelemetry::Propagator::XRay::IDGenerator

The propagator and ID generation are independent and do not need to be used in conjunction but can be.

How can I get involved?

The opentelemetry-propagator-xray 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.


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