seantbooker / opentelemetry-js-contrib

OpenTelemetry instrumentation for JavaScript modules

---

Getting Started   •   API Documentation   •   Getting In Touch (Gitter)

Contributing   •   Plugins   •   Propagators   •   Examples

---

About this project

This is a repository for OpenTelemetry JavaScript contributions that are not part of the core repository and core distribution of the API and SDK.

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

• @opentelemetry/plugin-grpc
• @opentelemetry/plugin-http
• @opentelemetry/plugin-https
• @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/instrumentation-koa
• @opentelemetry/instrumentation-graphql

Web Plugins

• @opentelemetry/plugin-document-load
• @opentelemetry/plugin-xml-http-request
• @opentelemetry/instrumentation-user-interaction
• @opentelemetry/plugin-react-load

Metapackages

Multiple plugins may be leveraged via metapackages.

• @opentelemetry/plugins-node-core-and-contrib - all officially supported core and contrib plugins.

Supported Runtimes

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

Node Support

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

Browser Support

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.

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.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For help or feedback on this project, join us on gitter

License

Apache 2.0 - See LICENSE for more information.