@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

0.24.0

:boom: Breaking Change

• opentelemetry-core, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-node, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-semantic-conventions, opentelemetry-web
  • #2345 feat: updated spec to v1.5.0 and renamed resource class (@weyert)

:rocket: (Enhancement)

• opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector
  • #2337 Support gzip compression for node exporter collector (@alisabzevari)
• opentelemetry-instrumentation-http
  • #2332 feat(@opentelemetry-instrumentation-http): support adding custom attributes before a span is started (@echoontheway)
  • #2349 fix(instrumentation-http): set outgoing request attributes on start span (@blumamir)
• opentelemetry-web
  • #2343 feat(opentelemetry-web): capture decodedBodySize / http.response_content_length_uncompressed (@t2t2)
• opentelemetry-instrumentation
  • #2309 chore: add includePrerelease option to instrumentation config (@dyladan)

:bug: (Bug Fix)

• opentelemetry-exporter-collector
  • #2357 fix: headers are appended to existing one (open-telemetry#2335) (@niko-achilles)
• opentelemetry-exporter-collector-grpc
  • #2322 fix(@opentelemetry/exporter-collector-grpc) regression from #2130 when host specified without protocol (@lizthegrey)
• opentelemetry-exporter-collector-proto
  • #2331 Change default HTTP exporter port to 55681 (@NathanielRN)

:books: (Refine Doc)

• Other
  • #2344 Additional website docs updates (@svrnm)
  • #2365 docs: add quickstart code example (@vreynolds)
  • #2358 examples opentelemetry-api version fix (@CptSchnitz)
  • #2308 chore: use typedoc to build sdk reference (@dyladan)
  • #2324 fix: update and make website docs work (@svrnm)
  • #2328 chore: updating compatibility matrix (@obecny)
  • #2326 chore: fix tracer-web example webpack config (@jonchurch)
• opentelemetry-resource-detector-aws
  • #2379 fix: fixup aws detector readme (@legendecas)
• opentelemetry-propagator-b3
  • #2342 docs: updates README.md for @opentelemetry/propagator-b3 (@OmkarKirpan)
• opentelemetry-exporter-collector-grpc
  • #2266 fix(exporter-collector-grpc): incorrect URL format on docs after 0.20.0 update (@brunoluiz)

:house: (Internal)

• Other
  • #2366 chore: adding Rauno56 to js approvers (@obecny)
  • #2350 chore: ignore backcompat in renovate (@dyladan)
  • #2352 replaced word plugin with instrumentation (@niko-achilles)
  • #2311 chore: ignore @types/node in backcompat (@dyladan)
• opentelemetry-exporter-collector-grpc, opentelemetry-exporter-jaeger, opentelemetry-instrumentation, opentelemetry-node, opentelemetry-sdk-node, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
  • #2351 style: use single quotes everywhere and add a rule to eslint (@blumamir)
• template
  • #2319 chore: update package template engines version (@jonchurch)

Committers: 18

• (Eliseo) Nathaniel Ruiz Nowell (@NathanielRN)
• Ali Sabzevari (@alisabzevari)
• Amir Blum (@blumamir)
• Bartlomiej Obecny (@obecny)
• Bruno Luiz Silva (@brunoluiz)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Jonathan Church (@jonchurch)
• Liz Fong-Jones (@lizthegrey)
• Niko Achilles Kokkinos (@niko-achilles)
• Ofer Adelstein (@CptSchnitz)
• Omkar Kirpan (@OmkarKirpan)
• Severin Neumann (@svrnm)
• Vera Reynolds (@vreynolds)
• Weyert de Boer (@weyert)
• @echoontheway
• legendecas (@legendecas)
• t2t2 (@t2t2)