https://github.com/open-telemetry/opentelemetry-js-contrib
OpenTelemetry instrumentation for JavaScript modules
https://github.com/open-telemetry/opentelemetry-js-contrib
Last synced: 24 days ago
JSON representation
OpenTelemetry instrumentation for JavaScript modules
- Host: GitHub
- URL: https://github.com/open-telemetry/opentelemetry-js-contrib
- Owner: open-telemetry
- License: apache-2.0
- Created: 2020-04-15T17:16:11.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T08:56:39.000Z (about 1 month ago)
- Last Synced: 2025-05-08T18:08:54.677Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://opentelemetry.io
- Size: 50.9 MB
- Stars: 781
- Watchers: 16
- Forks: 574
- Open Issues: 241
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-list - opentelemetry-js-contrib - telemetry | 128 | (TypeScript)
README
---
Getting Started
•
API Documentation
Contributing
•
Instrumentations
•
Propagators
•
Examples
---
# OpenTelemetry JavaScript Contrib
A repository for community-maintained OpenTelemetry JavaScript contributions that are not part of the [core repository](https://github.com/open-telemetry/opentelemetry-js) and core distribution of the API and the SDK.
This project includes:
- [Instrumentations & other plugins](./plugins),
- [Metapackages](./metapackages),
- [Context Propagators](./propagators),
- [Resource Detectors](./detectors).
**Instrumentations**: OpenTelemetry can collect tracing data automatically using instrumentations. Vendors/Users can also create and use their own.
Please read the [contributing guidelines on adding new instrumentation](CONTRIBUTING.md#new-instrumentation) before opening any PRs.
**Resource Detectors**: OpenTelemetry can collect resource attributes of the entity that producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the `Resource`.
## Component Ownership
This repository includes various components, each maintained by one or more designated component owners. Unless
necessary to resolve disagreements, [@open-telemetry/javascript-maintainers](https://github.com/orgs/open-telemetry/teams/javascript-maintainers)
take a more passive role when it comes to Maintaining these components.
Component owners have the authority to make decisions on implementation and feature requests, following the best practices
and the [mission, vision and values](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md) of the OpenTelemetry Project. They are also assigned the Triager role to manage issues
related to their components, and are the primary contact for conducting PR reviews for their components.
Component owners are automatically assigned to pull requests as reviewers. The source of truth for component ownership
is [.github/component_owners.yml](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/.github/component_owners.yml).
## Stability levels
Stability level for components in this repository follow the definitions in [CONTRIBUTING.md](./CONTRIBUTING.md).
## Supported Runtimes
Packages in this repository have a variable range of support for Node.JS and browser versions which for each package depend on
- the activeness of the owners of those packages,
- used techniques or runtime features and
- in the case of the auto-instrumentations, the supported runtime versions for the underlying package.
See the `README.md` files and the `engines` field in the `package.json` files for the respective packages for support information about that package.
See [the support section](https://github.com/open-telemetry/opentelemetry-js#node-support) in the core repository for more general information.
## Contributing
We'd love your help! Use tags [up-for-grabs][up-for-grabs-issues] and [good first issue][good-first-issues] to get started with the project. Follow [CONTRIBUTING](CONTRIBUTING.md) guide to report issues or submit a proposal.
### Thanks to all the people who already contributed
## Useful links
- For more information on OpenTelemetry, visit [OpenTelemetry.io](https://opentelemetry.io/)
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] or in [Slack](https://cloud-native.slack.com/archives/C01NL1GRPQR)
- For more 3rd party components for JS as well as other languages, check [OpenTelemetry Registry](https://opentelemetry.io/registry/)
## License
Apache 2.0 - See [LICENSE][license-url] for more information.
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[up-for-grabs-issues]: https://github.com/open-telemetry/opentelemetry-js-contrib/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs
[good-first-issues]: https://github.com/open-telemetry/openTelemetry-js-contrib/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22