/opentelemetry-collector-contrib

Contrib repository for the OpenTelemetry Collector

Primary LanguageGoApache License 2.0Apache-2.0


Getting Started   •   Getting Involved   •   Getting In Touch

Build Status Go Report Card Codecov Status GitHub release (latest by date including pre-releases) Beta

Vision   •   Design   •   Monitoring   •   Performance   •   Security   •   Roadmap


OpenTelemetry Collector Contrib

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.

Stability levels

Stability level for components in this repository follow the definitions from the OpenTelemetry Collector repository.

Gated features

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.

Support

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.

Contributing

See CONTRIBUTING.md.

Triagers (@open-telemetry/collector-contrib-triagers)

Approvers (@open-telemetry/collector-contrib-approvers):

Maintainers (@open-telemetry/collector-contrib-maintainer):

Emeritus Maintainers

Learn more about roles in the community repository.

PRs and Reviews

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).