@opentelemetry/propagator-aws-xray
Advanced tools
OpenTelemetry AWS Xray propagator provides context propagation for systems that are using AWS X-Ray format.
@opentelemetry/propagator-aws-xray is an npm package that provides context propagation for AWS X-Ray within the OpenTelemetry framework. It allows you to propagate trace context in a format compatible with AWS X-Ray, enabling distributed tracing across services that use AWS X-Ray.
AWS X-Ray Trace Context Propagation
This feature allows you to register the AWS X-Ray propagator with the OpenTelemetry Node.js TracerProvider. This enables the propagation of trace context in a format compatible with AWS X-Ray, facilitating distributed tracing across services.
const { NodeTracerProvider } = require('@opentelemetry/node');
const { AwsXRayPropagator } = require('@opentelemetry/propagator-aws-xray');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register({
propagator: new AwsXRayPropagator(),
});
registerInstrumentations({
tracerProvider: provider,
});
console.log('AWS X-Ray Propagator registered with OpenTelemetry');@opentelemetry/propagator-b3 is an npm package that provides context propagation using the B3 format. B3 is a set of HTTP headers used for distributed tracing, originally created by Twitter. It is commonly used with Zipkin. This package is similar to @opentelemetry/propagator-aws-xray in that it provides a way to propagate trace context, but it uses the B3 format instead of the AWS X-Ray format.
@opentelemetry/propagator-jaeger is an npm package that provides context propagation using the Jaeger format. Jaeger is an open-source, end-to-end distributed tracing tool. This package is similar to @opentelemetry/propagator-aws-xray in that it provides a way to propagate trace context, but it uses the Jaeger format instead of the AWS X-Ray format.
@opentelemetry/propagator-ot-trace is an npm package that provides context propagation using the OpenTracing format. OpenTracing is a set of consistent, expressive, vendor-neutral APIs for distributed tracing. This package is similar to @opentelemetry/propagator-aws-xray in that it provides a way to propagate trace context, but it uses the OpenTracing format instead of the AWS X-Ray format.
component owners: @willarmiros @NathanielRN
The OpenTelemetry Propagator for AWS X-Ray provides HTTP header propagation for systems that are using AWS X-Amzn-Trace-Id format.
This propagator translates the OpenTelemetry SpanContext into the equivalent AWS header format, for use with the OpenTelemetry JS SDK.
TraceState is currently not propagated.
Compatible with OpenTelemetry JS API and SDK 1.0+.
npm install --save @opentelemetry/propagator-aws-xray
In the global tracer configuration file, configure the following:
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { AWSXRayPropagator } = require('@opentelemetry/propagator-aws-xray');
// ...
const provider = new NodeTracerProvider();
// Set the global trace context propagator to use X-Ray formatted trace header
provider.register({
propagator: new AWSXRayPropagator()
});
Example header:X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1
The header consists of three parts: the root trace ID, the parent ID and the sampling decision.
Root is analogous to the OpenTelemetry Trace ID, with some small format changes. For additional reading, see the AWS X-Ray Trace ID public documentation.
Apache 2.0 - See LICENSE for more information.
Metrics API 1.0.0
Metrics API is now stable and generally available. There are no changes between 1.0.0 and the previous 0.33.0 version.
FAQs
OpenTelemetry AWS Xray propagator provides context propagation for systems that are using AWS X-Ray format.
The npm package @opentelemetry/propagator-aws-xray receives a total of 343,682 weekly downloads. As such, @opentelemetry/propagator-aws-xray popularity was classified as popular.
We found that @opentelemetry/propagator-aws-xray demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.