@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.0.1 / Experimental 0.27.0

:boom: Breaking Change

• Other
  • #2566 feat!(metrics): remove batch observer (@dyladan)
  • #2485 feat!: Split metric and trace exporters into new experimental packages (@willarmiros)
  • #2540 fix(sdk-metrics-base): remove metric kind BATCH_OBSERVER (@legendecas)
  • #2496 feat(api-metrics): rename metric instruments to match feature-freeze API specification (@legendecas)
• opentelemetry-core
  • #2529 feat(api-metrics): add schemaUrl to meter creations (@legendecas)

:rocket: (Enhancement)

• Other
  • #2523 feat: Rename Labels to Attributes (@pirgeo)
  • #2559 feat(api-metrics): remove bind/unbind and bound instruments (@legendecas)
  • #2563 feat(sdk-metrics-base): remove per-meter config on MeterProvider.getMeter (@legendecas)
• opentelemetry-core
  • #2465 fix: prefer globalThis instead of window to support webworkers (@legendecas)
• opentelemetry-semantic-conventions
  • #2532 feat(@opentelemetry/semantic-conventions): change enum to object literals (@echoontheway)
  • #2528 feat: upgrade semantic-conventions to latest v1.7.0 spec (@weyert)
• opentelemetry-core, opentelemetry-sdk-trace-base
  • #2484 feat: new merge function (@obecny)

:bug: (Bug Fix)

• Other
  • #2610 fix: preventing double enable for instrumentation that has been already enabled (@obecny)
  • #2581 feat: lazy initialization of the gzip stream (@fungiboletus)
  • #2584 fix: fixing compatibility versions for detectors (@obecny)
  • #2558 fix(@opentelemetry/exporter-prometheus): unref prometheus server to prevent process running indefinitely (@mothershipper)
  • #2495 fix(sdk-metrics-base): metrics name should be in the max length of 63 (@legendecas)
  • #2497 feat(@opentelemetry-instrumentation-fetch): support reading response body from the hook applyCustomAttributesOnSpan (@echoontheway)
• opentelemetry-core
  • #2560 fix(core): support regex global flag in urlMatches (@moander)
• opentelemetry-exporter-zipkin
  • #2519 fix(exporter-zipkin): correct status tags names (@t2t2)

:books: (Refine Doc)

• Other
  • #2561 Use new canonical path to Getting Started (@chalin)
  • #2576 docs(instrumentation): update links in the Readme (@OlivierAlbertini)
  • #2600 docs: fix URLs in README post-experimental move (@arbourd)
  • #2579 doc: Move upgrade propagator notes to correct section (@NathanielRN)
  • #2568 chore(doc): update matrix with contrib version for 1.0 core (@vmarchaud)
  • #2555 docs: expose existing comments (@moander)
  • #2493 chore: remove getting started and link to documentation. (@svrnm)
• opentelemetry-core
  • #2604 Docs: Document the HrTime format (@JamesJHPark)

:house: (Internal)

• Other
  • #2404 chore: Fix lint warnings in instrumentation package (@alisabzevari)
  • #2533 chore: regularly close stale issues (@Rauno56)
  • #2570 chore: adding selenium tests with browserstack (@obecny)
  • #2522 chore: cleanup setting config in instrumentations (@Flarna)
  • #2541 chore: slim font size for section title in PR template (@legendecas)
  • #2509 chore: expand pull request template with action items (@pragmaticivan)
  • #2488 chore: inline sources in source maps (@dyladan)
  • #2514 chore: update stable dependencies to 1.0 (@dyladan)
• opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web
  • #2607 chore: update npm badge image links (@legendecas)
• opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-core, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resources, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web, opentelemetry-shim-opentracing
  • #2531 chore(deps): pin minor API version (@Flarna)
• opentelemetry-core
  • #2520 chore(deps): remove unused semver (@mhennoch)

Committers: 23

• (Eliseo) Nathaniel Ruiz Nowell (@NathanielRN)
• Ali Sabzevari (@alisabzevari)
• Antoine Pultier (@fungiboletus)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Dylan Arbour (@arbourd)
• Georg Pirklbauer (@pirgeo)
• Gerhard Stöbich (@Flarna)
• Ivan Santos (@pragmaticivan)
• Jack (@mothershipper)
• James (@JamesJHPark)
• MartenH (@mhennoch)
• Olivier Albertini (@OlivierAlbertini)
• Patrice Chalin (@chalin)
• Rauno Viskus (@Rauno56)
• Severin Neumann (@svrnm)
• Valentin Marchaud (@vmarchaud)
• Weyert de Boer (@weyert)
• William Armiros (@willarmiros)
• @echoontheway
• legendecas (@legendecas)
• moander (@moander)
• t2t2 (@t2t2)