Getting Started
Get started with OpenTelemetry in Node.js and in 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.
The current status of the major functional components for OpenTelemetry JavaScript is as follows:
Traces | Metrics | Logs |
---|---|---|
Stable | Stable | Experimental |
For releases, including the latest release, see Releases.
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.
OpenTelemetry JavaScript consists of the following repositories:
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
Get started with OpenTelemetry in Node.js and in the browser.
Capture telemetry from your application with zero source code modifications
Instrumentation for OpenTelemetry JavaScript
How to instrument libraries an app depends on
Process and export your telemetry data
OpenTelemetry JavaScript Context API Documentation
Context propagation for the JS SDK
Add details about your applications’ environment to your telemetry
Reduce the amount of telemetry created
Instrument your serverless functions with OpenTelemetry JavaScript
Read the OpenTelemetry JavaScript API reference (external page)
Explore more examples for OpenTelemetry JavaScript (external page)
Instrumentation libraries, exporters and other useful components for OpenTelemetry JavaScript