OpenTelemetry Tracing SDK

The tracing module 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/api
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.
//       Registering a working tracer provider allows the API methods to record traces.
new BasicTracerProvider().register();

// 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();

Config

Tracing configuration is a merge of user supplied configuration with both the default configuration as specified in config.ts and an environmentally configurable sampling (via OTEL_TRACES_SAMPLER and OTEL_TRACES_SAMPLER_ARG).

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 in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Current Tags

0.24.1-alpha.1 ... canary (5 years ago)
0.24.0 ... latest (5 years ago)
0.24.0 ... next (5 years ago)

143 Versions

0.24.1-alpha.1 [deprecated] ... 5 years ago
0.24.0 [deprecated] ... 5 years ago
0.24.1-alpha.31 [deprecated] ... 5 years ago
0.23.1-alpha.28 [deprecated] ... 5 years ago
0.23.1-alpha.24 [deprecated] ... 5 years ago
0.23.1-alpha.23 [deprecated] ... 5 years ago
0.23.1-alpha.15 [deprecated] ... 5 years ago
0.23.1-alpha.3 [deprecated] ... 5 years ago
0.23.1-alpha.18 [deprecated] ... 5 years ago
0.23.0 [deprecated] ... 5 years ago
0.23.1-alpha.17 [deprecated] ... 5 years ago
0.22.1-alpha.16 [deprecated] ... 5 years ago
0.22.1-alpha.15 [deprecated] ... 5 years ago
0.22.1-alpha.13 [deprecated] ... 5 years ago
0.22.1-alpha.3 [deprecated] ... 5 years ago
0.22.1-alpha.2 [deprecated] ... 5 years ago
0.22.0 [deprecated] ... 5 years ago
0.22.1-alpha.5 [deprecated] ... 5 years ago
0.21.1-alpha.3 [deprecated] ... 5 years ago
0.21.1-alpha.2 [deprecated] ... 5 years ago
0.21.1-alpha.1 [deprecated] ... 5 years ago
0.21.0 [deprecated] ... 5 years ago
0.21.1-alpha.7 [deprecated] ... 5 years ago
0.20.1-alpha.4 [deprecated] ... 5 years ago
0.20.1-alpha.3 [deprecated] ... 5 years ago
0.20.0 [deprecated] ... 5 years ago
0.20.1-alpha.49 [deprecated] ... 5 years ago
0.19.1-alpha.44 [deprecated] ... 5 years ago
0.19.1-alpha.43 [deprecated] ... 5 years ago
0.19.1-alpha.41 [deprecated] ... 5 years ago
0.19.1-alpha.38 [deprecated] ... 5 years ago
0.19.1-alpha.33 [deprecated] ... 5 years ago
0.19.1-alpha.31 [deprecated] ... 5 years ago
0.19.1-alpha.29 [deprecated] ... 5 years ago
0.19.1-alpha.28 [deprecated] ... 5 years ago
0.19.1-alpha.27 [deprecated] ... 5 years ago
0.19.1-alpha.26 [deprecated] ... 5 years ago
0.19.1-alpha.25 [deprecated] ... 5 years ago
0.19.1-alpha.23 [deprecated] ... 5 years ago
0.19.1-alpha.21 [deprecated] ... 5 years ago
0.19.1-alpha.19 [deprecated] ... 5 years ago
0.19.1-alpha.14 [deprecated] ... 5 years ago
0.19.1-alpha.13 [deprecated] ... 5 years ago
0.19.1-alpha.12 [deprecated] ... 5 years ago
0.19.1-alpha.11 [deprecated] ... 5 years ago
0.19.1-alpha.9 [deprecated] ... 5 years ago
0.19.1-alpha.7 [deprecated] ... 5 years ago
0.19.1-alpha.39 [deprecated] ... 5 years ago
0.19.1-alpha.37 [deprecated] ... 5 years ago
0.19.0 [deprecated] ... 5 years ago
0.19.1-alpha.36 [deprecated] ... 5 years ago
0.18.3-alpha.31 [deprecated] ... 5 years ago
0.18.3-alpha.30 [deprecated] ... 5 years ago
0.18.3-alpha.29 [deprecated] ... 5 years ago
0.18.3-alpha.28 [deprecated] ... 5 years ago
0.18.3-alpha.27 [deprecated] ... 5 years ago
0.18.3-alpha.25 [deprecated] ... 5 years ago
0.18.3-alpha.23 [deprecated] ... 5 years ago
0.18.3-alpha.20 [deprecated] ... 5 years ago
0.18.3-alpha.18 [deprecated] ... 5 years ago
0.18.3-alpha.17 [deprecated] ... 5 years ago
0.18.3-alpha.16 [deprecated] ... 5 years ago
0.18.3-alpha.14 [deprecated] ... 5 years ago
0.18.3-alpha.11 [deprecated] ... 5 years ago
0.18.3-alpha.10 [deprecated] ... 5 years ago
0.18.3-alpha.9 [deprecated] ... 5 years ago
0.18.3-alpha.7 [deprecated] ... 5 years ago
0.18.3-alpha.5 [deprecated] ... 5 years ago
0.18.3-alpha.4 [deprecated] ... 5 years ago
0.18.3-alpha.3 [deprecated] ... 5 years ago
0.18.3-alpha.1 [deprecated] ... 5 years ago
0.18.2 [deprecated] ... 5 years ago
0.18.3-alpha.2 [deprecated] ... 5 years ago
0.18.2-alpha.1 [deprecated] ... 5 years ago
0.18.1 [deprecated] ... 5 years ago
0.18.2-alpha.81 [deprecated] ... 5 years ago
0.18.1-alpha.26 [deprecated] ... 5 years ago
0.18.1-alpha.24 [deprecated] ... 5 years ago
0.18.1-alpha.23 [deprecated] ... 5 years ago
0.18.1-alpha.21 [deprecated] ... 5 years ago
0.18.1-alpha.20 [deprecated] ... 5 years ago
0.18.1-alpha.16 [deprecated] ... 5 years ago
0.18.1-alpha.13 [deprecated] ... 5 years ago
0.18.1-alpha.3 [deprecated] ... 5 years ago
0.18.0 [deprecated] ... 5 years ago
0.18.1-alpha.12 [deprecated] ... 5 years ago
0.17.1-alpha.11 [deprecated] ... 5 years ago
0.17.1-alpha.10 [deprecated] ... 5 years ago
0.17.1-alpha.8 [deprecated] ... 5 years ago
0.17.1-alpha.5 [deprecated] ... 5 years ago
0.17.1-alpha.2 [deprecated] ... 5 years ago
0.17.1-alpha.21 [deprecated] ... 5 years ago
0.17.0 [deprecated] ... 5 years ago
0.16.1-alpha.20 [deprecated] ... 5 years ago
0.16.1-alpha.18 [deprecated] ... 5 years ago
0.16.1-alpha.15 [deprecated] ... 5 years ago
0.16.1-alpha.14 [deprecated] ... 5 years ago
0.16.1-alpha.12 [deprecated] ... 5 years ago
0.16.1-alpha.11 [deprecated] ... 5 years ago
0.16.1-alpha.10 [deprecated] ... 5 years ago
0.16.0 [deprecated] ... 5 years ago
0.15.0 [deprecated] ... 5 years ago
0.14.0 [deprecated] ... 5 years ago
0.13.0 [deprecated] ... 5 years ago
0.12.1-alpha.7 [deprecated] ... 5 years ago
0.12.1-alpha.4 [deprecated] ... 5 years ago
0.12.0 [deprecated] ... 5 years ago
0.12.1-alpha.54 [deprecated] ... 5 years ago
0.11.1-alpha.53 [deprecated] ... 5 years ago
0.11.1-alpha.44 [deprecated] ... 6 years ago
0.11.1-alpha.36 [deprecated] ... 6 years ago
0.11.1-alpha.35 [deprecated] ... 6 years ago
0.11.1-alpha.15 [deprecated] ... 6 years ago
0.11.0 [deprecated] ... 6 years ago
0.11.1-alpha.48 [deprecated] ... 6 years ago
0.10.3-alpha.41 [deprecated] ... 6 years ago
0.10.3-alpha.40 [deprecated] ... 6 years ago
0.10.3-alpha.35 [deprecated] ... 6 years ago
0.10.3-alpha.34 [deprecated] ... 6 years ago
0.10.3-alpha.28 [deprecated] ... 6 years ago
0.10.3-canary.0 [deprecated] ... 6 years ago
0.10.2 [deprecated] ... 6 years ago
0.10.1 [deprecated] ... 6 years ago
0.10.0 [deprecated] ... 6 years ago
0.9.0 [deprecated] ... 6 years ago
0.8.3 [deprecated] ... 6 years ago
0.8.2 [deprecated] ... 6 years ago
0.8.1 [deprecated] ... 6 years ago
0.8.0 [deprecated] ... 6 years ago
0.7.0 [deprecated] ... 6 years ago
0.6.1 [deprecated] ... 6 years ago
0.6.0 [deprecated] ... 6 years ago
0.5.2 [deprecated] ... 6 years ago
0.5.1 [deprecated] ... 6 years ago
0.5.0 [deprecated] ... 6 years ago
0.4.0 [deprecated] ... 6 years ago
0.3.3 [deprecated] ... 6 years ago
0.3.2 [deprecated] ... 6 years ago
0.3.1 [deprecated] ... 6 years ago
0.3.0 [deprecated] ... 6 years ago
0.2.0 [deprecated] ... 6 years ago
0.1.1 [deprecated] ... 6 years ago
0.1.0 [deprecated] ... 7 years ago