@opentelemetry/shim-opentracing

OpenTracing shim

OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry

Installation

npm install --save @opentelemetry/shim-opentracing

Usage

Use the TracerShim wherever you initialize your OpenTracing tracers.

const opentracing = require('opentracing');

// Old tracer initialization.
const tracer = myOpenTracingTracer(...);
opentracing.initGlobalTracer(tracer);

// New tracer initialization.
import { TracerShim } from '@opentelemetry/shim-opentracing';

const tracer = myOpenTelemetryTracer(...)
opentracing.initGlobalTracer(new TracerShim(tracer));

Optionally, you can specify propagators to be used for the OpenTracing TextMap and HttpHeaders formats:

var b3Propagator = new B3Propagator();
new TracerShim(tracer, {
  textMapPropagator: b3Propagator,
  httpHeadersPropagator: b3Propagator
})

If propagators are not specified, OpenTelemetry's global propagator will be used.

See examples/opentracing-shim for a short example.

License

Apache 2.0 - See LICENSE for more information.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For help or feedback on this project, join us in GitHub Discussions

Changelog

1.25.0

:rocket: (Enhancement)

• feat: support node 22 #4666 @dyladan
• feat(context-zone*): support zone.js 0.12.x #4376 @maldago
• refactor(core): Use tree-shakeable string constants for semconv #4739 @JohannesHuster
• refactor(shim-opentracing): Use tree-shakeable string constants for semconv #4746 @JohannesHuster
• refactor(sdk-trace-web): Use tree-shakeable string constants for semconv #4747 @JohannesHuster
• refactor(sdk-trace-node): Use tree-shakeable string constants for semconv #4748 @JohannesHuster
• refactor(sdk-trace-base): Use tree-shakeable string constants for semconv #4749 @JohannesHuster
• refactor(resources): update deprecated semconv to use exported strings #4755 @JamieDanielson
• refactor(exporters): update deprecated semconv to use exported strings #4756 @JamieDanielson

:books: (Refine Doc)

• refactor(examples): use new exported string constants for semconv in examples/esm-http-ts #4758 @Zen-cronic
• refactor(examples): use new exported string constants for semconv in examples/basic-tracer-node #4759 @Zen-cronic
• refactor(examples): use new exported string constants for semconv in examples/http #4750 @Zen-cronic
• refactor(examples): use new exported string constants for semconv in examples/grpc-js #4760 @Zen-cronic
• refactor(examples): use new exported string constants for semconv in examples/otlp-exporter-node #4762 @Zen-cronic
• refactor(examples): use new exported string constants for semconv in examples/opentracing-shim #4761 @Zen-cronic