@opentelemetry/propagator-jaeger

What is @opentelemetry/propagator-jaeger?

The @opentelemetry/propagator-jaeger npm package is used for propagating trace context using the Jaeger format. This is part of the OpenTelemetry project, which provides a set of APIs, libraries, agents, and instrumentation to create and manage telemetry data (metrics, logs, and traces) for cloud-native software. The Jaeger propagator package specifically deals with the extraction and injection of trace context headers for distributed tracing.

What are @opentelemetry/propagator-jaeger's main functionalities?

Context Propagation

This feature allows the propagation of trace context using the Jaeger format. The code sample demonstrates how to import the JaegerHttpTracePropagator from the package and set it as the global propagator for handling trace context.

{"import { JaegerHttpTracePropagator } from '@opentelemetry/propagator-jaeger';\nimport { propagation } from '@opentelemetry/api';\n\n// Register the Jaeger propagator to handle the trace context\nconst jaegerPropagator = new JaegerHttpTracePropagator();\npropagation.setGlobalPropagator(jaegerPropagator);"}

Other packages similar to @opentelemetry/propagator-jaeger

@opentelemetry/propagator-b3

This package provides B3 propagation for OpenTelemetry. B3 propagation is used by Zipkin tracing. It is similar to the Jaeger propagator in that it handles the injection and extraction of trace context headers for distributed tracing, but it uses the B3 format instead of the Jaeger format.

@opentelemetry/propagator-aws-xray

This package is designed for AWS X-Ray tracing support. It propagates trace context using the AWS X-Ray format. Like the Jaeger propagator, it is used for distributed tracing, but it is specifically tailored to integrate with AWS X-Ray.

@opentelemetry/propagator-ot-trace

The OpenTracing propagator for OpenTelemetry provides context propagation using the OpenTracing format. It is another alternative for distributed tracing context propagation, similar to the Jaeger propagator, but adheres to the OpenTracing standard.

README

OpenTelemetry Propagator Jaeger

OpenTelemetry Jaeger propagator provides HTTP header propagation for systems that are using Jaeger HTTP header format.

Format: {trace-id}:{span-id}:{parent-span-id}:{flags}

• {trace-id}

  • 64-bit or 128-bit random number in base16 format.
  • Can be variable length, shorter values are 0-padded on the left.
  • Value of 0 is invalid.

• {span-id}

  • 64-bit random number in base16 format.

• {parent-span-id}

  • Set to 0 because this field is deprecated.

• {flags}

  • One byte bitmap, as two hex digits.

Example of usage:

const { NodeTracerProvider } = require('@opentelemetry/node');
const { JaegerPropagator } = require('@opentelemetry/propagator-jaeger');

const provider = new NodeTracerProvider();
provider.register({
  propagator: new JaegerPropagator()
});

Baggage Notes

Jeager Baggage is represented as multiple headers where the names are carrier dependent. For this reason, they are omitted from the fields method. This behavior should be taken into account if your application relies on the fields functionality. See the specification for more details.

Trace on Jaeger UI

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.23.0

:rocket: (Enhancement)

• opentelemetry-shim-opentracing
  • #2282 feat(shim-opentracing): update logging based on new spec (@vreynolds)
• opentelemetry-exporter-collector-grpc
  • #2304 feat: otlp-grpc exporter uses headers environment variables (@vreynolds)
• opentelemetry-propagator-b3
  • #2285 fix(propagator-b3): update extract to check for array (@jordanworner)
• opentelemetry-core, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-xml-http-request, opentelemetry-web
  • #2226 fix(xhr): make performance observer work with relative urls (@mhennoch)

:books: (Refine Doc)

• Other
  • #2306 chore: update the website getting started docs (@dyladan)
  • #2283 Module opentelemetry/instrumentation-grpc required (@pramodsreek)
• opentelemetry-sdk-node
  • #2300 chore(README): update link to BatchSpanProcessor in sdk node (@pragmaticivan)
• opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-sdk-node
  • #2290 fix: service.name resource attribute (@OmkarKirpan)
• opentelemetry-resources
  • #2289 docs(opentelemetry-resources): fix wrong sample code in readme (@alisabzevari)

:house: (Internal)

• opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-web
  • #2247 feat: unify the signatures of bind and with (@Rauno56)
• Other
  • #2296 chore: do not upgrade backwards compatibility (@dyladan)
  • #2302 chore: use setup-node (@dyladan)

Committers: 9

• Ali Sabzevari (@alisabzevari)
• Daniel Dyla (@dyladan)
• Ivan Santos (@pragmaticivan)
• Jordan Worner (@jordanworner)
• MartenH (@mhennoch)
• Omkar Kirpan (@OmkarKirpan)
• Pramod (@pramodsreek)
• Rauno Viskus (@Rauno56)
• Vera Reynolds (@vreynolds)