Getting Started • Getting Involved • Getting In Touch
Vision • Design • Monitoring • Performance • Security • Roadmap
This is a repository for OpenTelemetry Collector components that are not suitable for the core repository of the collector.
The official distributions, core and contrib, are available as part of the opentelemetry-collector-releases repository. Some of the components in this repository are part of the "core" distribution, such as the Jaeger and Prometheus components, but most of the components here are only available as part of the "contrib" distribution. Users of the OpenTelemetry Collector are also encouraged to build their own custom distributions with the OpenTelemetry Collector Builder, using the components they need from the core repository, the contrib repository, and possibly third-party or internal repositories.
Each component has its own support levels, as defined in the following sections. For each signal that a component supports, there's a stability level, setting the right expectations. It is possible then that a component will be Stable for traces but Alpha for metrics and In Development for logs.
While we intend to provide high-quality components as part of this repository, we acknowledge that not all of them are ready for prime time. As such, each component should list its current stability level for each telemetry signal, according to the following definitions:
- In development: not all pieces of the component are in place yet and it might not be available as part of any distributions yet. Bugs and performance issues should be reported, but it is likely that the component owners might not give them much attention. Your feedback is still desired, especially when it comes to the user-experience (configuration options, component observability, technical implementation details, ...). Configuration options might break often depending on how things evolve. The component should not be used in production.
- Alpha: the component is ready to be used for limited non-critical workloads and the authors of this component would welcome your feedback. Bugs and performance problems should be reported, but component owners might not work on them right away. The configuration options might change often without backwards compatibility guarantees.
- Beta: same as Alpha, but the configuration options are deemed stable. While there might be breaking changes between releases, component owners should try to minimize them. A component at this stage is expected to have had exposure to non-critical production workloads already during its Alpha phase, making it suitable for broader usage.
- Stable: the component is ready for general availability. Bugs and performance problems should be reported and there's an expectation that the component owners will work on them. Breaking changes, including configuration options and the component's output are not expected to happen without prior notice, unless under special circumstances.
- Deprecated: the component is planned to be removed in a future version and no further support will be provided. Note that new issues will likely not be worked on. When a component enters "deprecated" mode, it is expected to exist for at least two minor releases. See the component's readme file for more details on when a component will cease to exist.
Some features are hidden behind feature gates before they are part of the main code path for the component. Note that the feature gates themselves might be at different lifecycle stages.
Each component is supported either by the community of OpenTelemetry Collector Contrib maintainers, as defined by the GitHub group @open-telemetry/collector-contrib-maintainer, or by specific vendors. See the individual README files for information about the specific components.
The OpenTelemetry Collector Contrib maintainers may at any time downgrade specific components, including vendor-specific ones, if they are deemed unmaintained or if they pose a risk to the repository and/or binary distribution.
Even though the OpenTelemetry Collector Contrib maintainers are ultimately responsible for the components hosted here, actual support will likely be provided by individual contributors, typically a code owner for the specific component.
See CONTRIBUTING.md.
Triagers (@open-telemetry/collector-contrib-triagers)
- Alolita Sharma, AWS
- Punya Biswal, Google
- Steve Flanders, Splunk
Approvers (@open-telemetry/collector-contrib-approvers):
- Anthony Mirabella, AWS
- David Ashpole, Google
- Dmitrii Anoshin, Splunk
- Pablo Baeyens, DataDog
- Przemek Maciolek, Sumo Logic
Maintainers (@open-telemetry/collector-contrib-maintainer):
- Daniel Jaglowski, observIQ
- Juraci Paixão Kröhling, Grafana Labs
- Alex Boten, Lightstep
- Bogdan Drutu, Splunk
Emeritus Maintainers
- Tigran Najaryan, Splunk
Learn more about roles in the community repository.
When creating a PR please following the process described here.
News PRs will be automatically associated with the reviewers based on CODEOWNERS. PRs will be also automatically assigned to one of the maintainers or approvers for facilitation.
The facilitator is responsible for helping the PR author and reviewers to make progress or if progress cannot be made for closing the PR.
If the reviewers do not have approval rights the facilitator is also responsible for the official approval that is required for the PR to be merged and if the facilitator is a maintainer they are responsible for merging the PR as well.
The facilitator is not required to perform a thorough review, but they are encouraged to enforce Collector best practices and consistency across the codebase and component behavior. The facilitators will typically rely on codeowner's detailed review of the code when making the final approval decision.
We recommend maintainers and approvers to keep an eye on the project board. All newly created PRs are automatically added to this board. (If you don't see the PR on the board you may need to add it manually by setting the Project field in the PR view).