open-telemetry
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 and core distribution of the API and the SDK.
This project includes:
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 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 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 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.
Stability levels
Stability level for components in this repository follow the definitions in 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 in the core repository for more general information.
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.
Thanks to all the people who already contributed
Useful links
- For more information on OpenTelemetry, visit OpenTelemetry.io
- For help or feedback on this project, join us in GitHub Discussions or in Slack
- For more 3rd party components for JS as well as other languages, check OpenTelemetry Registry
License
Apache 2.0 - See LICENSE for more information.