Getting Started • API Documentation • Getting In Touch (Gitter)
Contributing • Development Guide • Benchmarks • Examples
This is the JavaScript version of OpenTelemetry, a framework for collecting traces and metrics from applications.
To get started tracing your own application, see the Getting Started Guide. For more information about automatic instrumentation see @opentelemetry/node, which provides auto-instrumentation for Node.js applications. If the automatic instrumentation does not suit your needs, or you would like to create manual traces, see @opentelemetry/tracing
If you are a library author looking to build OpenTelemetry into your library, please see the documentation. As a library author, it is important that you only depend on properties and methods published on the public API. If you use any properties or methods from the SDK that are not officially a part of the public API, your library may break if an Application Owner uses a different SDK implementation.
| Platform Version | Supported |
|---|---|
Node.JS v14 |
✅ |
Node.JS v12 |
✅ |
Node.JS v10 |
✅ |
Node.JS v8 |
See Node Support below |
| Web Browsers | ✅ See Browser Support below |
Automated tests are run using the latest release of each currently active version of Node.JS.
While Node.JS v8 is no longer supported by the Node.JS team, the latest version of Node.JS v8 is still included in our testing suite.
Please note that versions of Node.JS v8 prior to v8.5.0 will NOT work, because OpenTelemetry Node depends on the perf_hooks module introduced in v8.5.0
Automated browser tests are run in the latest version of Headless Chrome. There is currently no list of officially supported browsers, but OpenTelemetry is developed using standard web technologies with wide support and should work in currently supported versions of major browsers.
OpenTelemetry JS is under active development. This release isn't guaranteed to conform to a specific version of the specification, and future releases will not attempt to maintain backwards compatibility with the alpha release.
| Component | Initial Version | Release Date |
|---|---|---|
| Tracing API | Alpha v0.1.0 | October 14 2019 |
| Tracing SDK (Node and Web) | Alpha v0.1.0 | October 14 2019 |
| Jaeger Trace Exporter | Alpha v0.1.0 | October 14 2019 |
| Trace Context Propagation | Alpha v0.1.0 | October 14 2019 |
| Zipkin Trace Exporter | Alpha v0.1.0 | October 14 2019 |
| OpenTracing Bridge | Alpha v0.1.0 | October 14 2019 |
| Metrics API | Alpha v0.2.0 | November 04 2019 |
| Metrics SDK | Alpha v0.2.0 | November 04 2019 |
| Prometheus Metric Exporter | Alpha v0.3.0 | December 13 2019 |
| Resources | Beta v0.5.0 | March 16 2020 |
| Metrics SDK (Complete) | Beta v0.5.0 | March 16 2020 |
| OpenCensus Bridge | Unknown | Unknown |
| Support for Tags/Baggage | Unknown | Unknown |
Last updated March 2020
| Feature | API Status | Specification Target | SDK Status |
|---|---|---|---|
| Tracing | Beta | v0.3 | Beta |
| Metrics | Beta | v0.3 | Beta |
| Context | Beta | v0.3 | Beta |
| Propagation | Beta | v0.3 | Beta |
| Baggage | Alpha | v0.3 | Development |
| OpenTracing Bridge | N/A | v0.3 | Beta |
| Resources | N/A | v0.3 | Beta |
See the project milestones for details on upcoming releases. The dates and features described here are estimates, and subject to change.
We'd love your help!. Use tags up-for-grabs and good first issue to get started with the project. For instructions to build and make changes to this project, see the CONTRIBUTING guide.
We have a weekly SIG meeting! See the community page for meeting details and notes.
Approvers (@open-telemetry/js-approvers):
- Olivier Albertini, Ville de Montréal
- Valentin Marchaud, Open Source Contributor
- Mark Wolff, Microsoft
- Matthew Wear, LightStep
- Naseem K. Ullah, Transit
- Chengzhong Wu, Alibaba
Find more about the approver role in community repository.
Maintainers (@open-telemetry/js-maintainers):
- Mayur Kale, Google
- Daniel Dyla, Dynatrace
- Bartlomiej Obecny, LightStep
Find more about the maintainer role in community repository.
| Package | Description |
|---|---|
| @opentelemetry/api | This package provides TypeScript interfaces, enums and no-op implementations for the OpenTelemetry core trace and metrics model. It is intended for use both on the server and in the browser. |
| @opentelemetry/core | This package provides default and no-op implementations of the OpenTelemetry api for trace and metrics. It's intended for use both on the server and in the browser. |
| Package | Description |
|---|---|
| @opentelemetry/tracing | This module provides a full control over instrumentation and span creation. It doesn't load async_hooks or any instrumentation plugin by default. It is intended for use both on the server and in the browser. |
| @opentelemetry/metrics | This module provides instruments and meters for reporting of time series data. |
| @opentelemetry/node | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
| @opentelemetry/web | This module provides automated instrumentation and tracing for Web applications. It is intended for use in the browser only. |
OpenTelemetry is vendor-agnostic and can upload data to any backend with various exporter implementations. Even though, OpenTelemetry provides support for many backends, vendors/users can also implement their own exporters for proprietary and unofficially supported backends.
See the OpenTelemetry registry for a list of exporters available.
OpenTelemetry can collect tracing data automatically using plugins. Vendors/Users can also create and use their own. Currently, OpenTelemetry supports automatic tracing for:
- @opentelemetry/plugin-grpc
- @opentelemetry/plugin-grpc-js
- @opentelemetry/plugin-http
- @opentelemetry/plugin-https
These plugins are hosted at https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node
- @opentelemetry/plugin-mongodb
- @opentelemetry/plugin-mysql
- @opentelemetry/plugin-pg
- @opentelemetry/plugin-pg-pool
- @opentelemetry/plugin-redis
- @opentelemetry/plugin-ioredis
- @opentelemetry/plugin-express
- @opentelemetry/plugin-dns
- @opentelemetry/hapi-instrumentation
- @opentelemetry/koa-instrumentation
These plugins are hosted at https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web
To request automatic tracing support for a module not on this list, please file an issue. Alternatively, you can write a plugin yourself.
| Package | Description |
|---|---|
| @opentelemetry/shim-opentracing | OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry |
PR-1764 removed some APIs from Tracer:
Tracer.getCurrentSpan(): useapi.getSpan(api.context.active())Tracer.withSpan(span): useapi.context.with(api.setSpan(api.context.active(), span))Tracer.bind(target): useapi.context.bind(target)
- For more information on OpenTelemetry, visit: https://opentelemetry.io/
- For help or feedback on this project, join us on gitter
Apache 2.0 - See LICENSE for more information.