Skip to content

Latest commit

 

History

History
163 lines (120 loc) · 10.8 KB

README.md

File metadata and controls

163 lines (120 loc) · 10.8 KB
Raw

OpenTelemetry - distributed tracing and stats collection framework

Gitter chat CircleCI Coverage Status Apache License

About this project

This is the JavaScript version of OpenTelemetry, a framework for collecting traces, metrics and logs from applications.

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!

Quick start

To get started tracing your own application, see the Getting Started Guide.

For more information, see @opentelemetry/tracing for an SDK that supports creating traces through manual instrumentation or @opentelemetry/node which provides auto-instrumentation for Node.js applications.

Release Schedule

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 (Counter and Gauge support) - Export work is underway.

The v0.3 alpha release includes:

  • Prometheus Metric Exporter
  • OpenTelemetry Collector Exporter
  • mongodb, redis, mysql Instrumentations

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:

Component Version Target Date
Support for Tags/Baggage Alpha v0.4 January 31 2020
Metrics Aggregation Alpha v0.4 January 31 2020
Metrics SDK (Complete) Alpha v0.4 January 31 2020
OpenCensus Bridge Alpha v0.4 January 31 2020

Contributing

We'd love your help!. Use tags up-for-grabs and good first issue to get started with the project. Follow CONTRIBUTING guide to report issues or submit a proposal.

We have a weekly SIG meeting! See the community page for meeting details and notes.

Approvers (@open-telemetry/js-approvers):

Find more about the approver role in community repository.

Maintainers (@open-telemetry/js-maintainers):

Find more about the maintainer role in community repository.

Packages

API

Package Description
@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

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/base This package provides base code for the SDK packages (tracing and metrics).

Exporters

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:

Trace Exporters

Metric Exporters

Plugins

OpenTelemetry can collect tracing data automatically using plugins. Vendors/Users can also create and use their own. Currently, OpenTelemetry supports automatic tracing for:

Node Plugins

Web Plugins

To request automatic tracing support for a module not on this list, please file an issue. Alternatively, you can write a plugin yourself.

Shims

Package Description
@opentelemetry/shim-opentracing OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry

Useful links

License

Apache 2.0 - See LICENSE for more information.