@opentelemetry/tracing

OpenTelemetry Tracing

tracing contains the foundation for all tracing SDKs of opentelemetry-js.

Used standalone, this module provides methods for manual instrumentation of code, offering full control over span creation for client-side JavaScript (browser) and Node.js.

It does not provide automated instrumentation of known libraries, context propagation for asynchronous invocations or distributed-context out-of-the-box.

For automated instrumentation for Node.js, please see @opentelemetry/node.

Installation

npm install --save @opentelemetry/core
npm install --save @opentelemetry/tracing

Usage

const opentelemetry = require('@opentelemetry/api');
const { BasicTracerProvider } = require('@opentelemetry/tracing');

// To start a trace, you first need to initialize the Tracer provider.
// NOTE: the default OpenTelemetry tracer provider does not record any tracing information.
opentelemetry.trace.initGlobalTracerProvider(new BasicTracerProvider());

// To create a span in a trace, we used the global singleton tracer to start a new span.
const span = opentelemetry.trace.getTracer('default').startSpan('foo');

// Set a span attribute
span.setAttribute('key', 'value');

// We must end the spans so they become available for exporting.
span.end();

Example

See examples/basic-tracer-node for an end-to-end example, including exporting created spans.

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.4.0

Released 2020-02-05

:rocket: (Enhancement)

• opentelemetry-api
  • #727 Api separation (deprecate opentelemetry-types)
  • #749 chore: rename registry to provider

:sparkles: (Feature)

• opentelemetry-plugin-http
  • #719 feat(plugin-http): sync. specs for statuscode
• opentelemetry-exporter-jaeger
  • #735 feat: decode jaeger header
• opentelemetry-plugin-user-interaction
  • #658 feat: plugin user interaction for web

:books: (Refine Doc)

• #689 Add benchmark README and latest numbers
• #733 chore: add instruction for pg-pool plugin
• #665 docs: add ioredis example
• #731 Update Stackdriver exporter example

:bug: (Bug Fix)

• opentelemetry-exporter-jaeger
  • #715 fix: unref jaeger socket to prevent process running indefinitely
• opentelemetry-plugin-ioredis
  • #671 [ioredis plugin] fix: change supportedVersions to >1 <5