Getting Started
Get started with OpenTelemetry in Node.js and in the browser.
JavaScript
A language-specific implementation of OpenTelemetry in JavaScript (for Node.js & the browser).This is the OpenTelemetry JavaScript documentation. OpenTelemetry is an observability framework – an API, SDK, and tools that are designed to aid in the generation and collection of application telemetry data such as metrics, logs, and traces. This documentation is designed to help you understand how to get started using OpenTelemetry JavaScript.
Status and Releases
The current status of the major functional components for OpenTelemetry JavaScript is as follows:
| Traces | Metrics | Logs |
|---|---|---|
| Stable | Stable | Development |
For releases, including the latest release, see Releases.
Warning
Client instrumentation for the browser is experimental and mostly unspecified. If you are interested in helping out, get in touch with the Client Instrumentation SIG.Version Support
OpenTelemetry JavaScript supports all active or maintenance LTS versions of Node.js. Previous versions of Node.js may work, but are not tested by OpenTelemetry.
OpenTelemetry JavaScript has no official supported list of browsers. It is aimed to work on currently supported versions of major browsers.
For more details on runtime support see this overview.
Repositories
OpenTelemetry JavaScript consists of the following repositories:
- opentelemetry-js, core repository containing the core distribution API and SDK.
- opentelemetry-js-contrib, contributions that are not part of the core distribution of the API and SDK.
Help or Feedback
If you have questions about OpenTelemetry JavaScript, please reach out via GitHub Discussions or the [#otel-js] channel on CNCF Slack.
If you want to contribute to OpenTelemetry JavaScript, see the contributing instructions
Instrumentation
Instrumentation for OpenTelemetry JavaScript
Using instrumentation libraries
How to instrument libraries an app depends on
Exporters
Process and export your telemetry data
Context
OpenTelemetry JavaScript Context API Documentation
Propagation
Context propagation for the JS SDK
Resources
Add details about your applications’ environment to your telemetry
Sampling
Reduce the amount of telemetry created
Serverless
Instrument your serverless functions with OpenTelemetry JavaScript
API reference
Read the OpenTelemetry JavaScript API reference (external page)
Examples
Explore more examples for OpenTelemetry JavaScript (external page)
Registry
Instrumentation libraries, exporters and other useful components for OpenTelemetry JavaScript
[i18n] feedback_title
[i18n] feedback_question
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!