OpenTelemetry - distributed tracing and stats collection framework
About this project
This project is currently in Alpha stage. Its APIs can change at any time and it is not intended to be used in production scenarios!
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.
The v0.2 alpha release includes:
- Tracing API
- Tracing SDK (Node and Web)
- Metrics API
- Jaeger Trace Exporter
- Zipkin Trace Exporter
- OpenTracing Bridge
- HTTP, GRPC, DNS Instrumentations
- Document Load for web
- Metrics SDK (
Gaugesupport) - Export work is underway.
See the project milestones for details on upcoming releases. The dates and features described here are estimates, and subject to change.
Future release targets include:
|Prometheus Metrics Exporter||Alpha v0.3||November 15 2019|
|mongodb Instrumentation||Alpha v0.3||November 15 2019|
|postgres Instrumentation||Alpha v0.3||November 15 2019|
|OpenCensus Bridge||Alpha v0.3||tbd|
We have a weekly SIG meeting! See the community page for meeting details and notes.
- Yuri Shkuro, Uber
- Roch Devost, DataDog
- Brandon Gonzalez, LightStep
- Olivier Albertini, VilledeMontreal
- Valentin Marchaud, Open Source Contributor
- Mark Wolff, Microsoft
- Bartlomiej Obecny, LightStep
Find more about the approver role in community repository.
Find more about the maintainer role in community repository.
|@opentelemetry/types||This package provides TypeScript interfaces and enums 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 types for trace and metrics. It's intended for use both on the server and in the browser.|
Implementation / SDKs
|@opentelemetry/tracing||This module provides a full control over instrumentation and span creation. It doesn't load
|@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. Currently, OpenTelemetry supports:
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-mongodb - WIP
- @opentelemetry/plugin-postgres - WIP
|@opentelemetry/shim-opentracing||OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry|
- 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.