@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 { JaegerHttpTracePropagator } = require('@opentelemetry/propagator-jaeger');

const provider = new NodeTracerProvider();
provider.register({
  // Use Jaeger propagator
  propagator: new JaegerHttpTracePropagator()
});

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 on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.13.0

:boom: Breaking Change

• opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-metrics, opentelemetry-sdk-node
  • #1700 Metrics updates (@obecny)
• opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-shim-opentracing, opentelemetry-tracing
  • #1644 fix!: change status codes from grpc status codes (@lonewolf3739)
• opentelemetry-core, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-metrics, opentelemetry-tracing
  • #1643 refactor: new interface for ExportResult #1569 (@vmarchaud)
• opentelemetry-api, opentelemetry-core, opentelemetry-plugin-fetch, opentelemetry-plugin-xml-http-request, opentelemetry-propagator-b3, opentelemetry-web
  • #1595 chore!: move b3 into its own package (@mwear)
• opentelemetry-api, opentelemetry-core, opentelemetry-plugin-fetch, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-shim-opentracing
  • #1576 feat: add keys operation to getter (@dyladan)

:rocket: (Enhancement)

• opentelemetry-resource-detector-aws
  • #1669 Feat: Added Amazon EKS Resource Detector (@KKelvinLo)
• opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-metrics, opentelemetry-sdk-node
  • #1700 Metrics updates (@obecny)
• opentelemetry-tracing
  • #1692 chore: remove unused tracer config gracefulShutdown (@Flarna)
  • #1622 fix(tracing): use globalErrorHandler when flushing fails (@johanneswuerbach)
• opentelemetry-semantic-conventions
  • #1670 feat(semantic-conventions): FaaS specifications (@nirsky)
• opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-metrics
  • #1628 fix: boundaries option propagation in ValueRecorder Metric (@AndrewGrachov)
• opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector
  • #1607 feat(exporter-collector): log upstream error #1459 (@vmarchaud)
• opentelemetry-instrumentation-xml-http-request
  • #1651 chore: use performance directly in xhr plugin (@dyladan)
• opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-web
  • #1659 feat: replacing base plugin with instrumentation for xml-http-request (@obecny)
• opentelemetry-core, opentelemetry-tracing
  • #1653 chore: env vars for span limit as per specification (@jtmalinowski)
• opentelemetry-exporter-zipkin
  • #1474 chore(zipkin): export ExporterConfig (@shivkanya9146)
• opentelemetry-api, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-tracing
  • #1612 chore: remove explicit parent option (@dyladan)
• opentelemetry-exporter-zipkin, opentelemetry-plugin-http, opentelemetry-tracing
  • #1632 feat: span processor onstart recieves context (@dyladan)
• opentelemetry-api, opentelemetry-core, opentelemetry-tracing
  • #1631 chore: sampler gets a full context (@dyladan)
• opentelemetry-api, opentelemetry-core, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-propagator-b3
  • #1615 chore: add fields operation to TextMapPropagator (@dyladan)
• opentelemetry-plugin-xml-http-request, opentelemetry-tracing
  • #1621 chore: ensure onStart is called with a writeable span (@dyladan)
• opentelemetry-api, opentelemetry-core
  • #1597 fix: make TraceState immutable (@Flarna)

:bug: (Bug Fix)

• opentelemetry-tracing
  • #1666 fix: clear BatchSpanProcessor internal spans buffer before exporting (@TsvetanMilanov)
• opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector
  • #1641 fix: do not access promise before resolve (@obecny)
  • #1627 chore: fixing conversion of id to hex and base64 (@obecny)

:books: (Refine Doc)

• opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-instrumentation-xml-http-request
  • #1696 chore: use WebTracerProvider instead of WebTracer in docs (@bradfrosty)
• opentelemetry-api
  • #1650 docs: document null and undefined attribute values undefined behavior (@dyladan)
• opentelemetry-context-zone-peer-dep, opentelemetry-web
  • #1616 docs: zone ctx manager can only be used with es2015 (@dyladan)

Committers: 16

• Andrew (@AndrewGrachov)
• Bartlomiej Obecny (@obecny)
• Brad Frost (@bradfrosty)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Jakub Malinowski (@jtmalinowski)
• Johannes Würbach (@johanneswuerbach)
• Kelvin Lo (@KKelvinLo)
• Matthew Wear (@mwear)
• Naga (@tannaga)
• Nir Hadassi (@nirsky)
• Shivkanya Andhare (@shivkanya9146)
• Srikanth Chekuri (@lonewolf3739)
• Tsvetan Milanov (@TsvetanMilanov)
• Valentin Marchaud (@vmarchaud)
• @snyder114