OpenTelemetry Operator for Kubernetes

The OpenTelemetry Operator is an implementation of a Kubernetes Operator.

The operator manages:

• OpenTelemetry Collector
• auto-instrumentation of the workloads using OpenTelemetry instrumentation libraries

Documentation

User documentation lives under docs/:

• Getting started — installation, upgrades, compatibility
• Concepts — what the operator manages
• Collector — OpenTelemetryCollector CRD: deployment modes, sidecar injection, observability
• Auto-instrumentation — Instrumentation CRD: per-language injection, resource attributes
• Target Allocator — Prometheus scrape target distribution and discovery
• OpAMP Bridge — OpAMPBridge CRD
• Use cases - Task-oriented guides for common observability scenarios with the OpenTelemetry Operator.
• Troubleshooting — debug tips and known issues
• Reference — API docs, CRD changelog, feature gates
• RFCs — design proposals
• Official OpenTelemetry Operator page

Helm Charts

You can install OpenTelemetry Operator via Helm Chart from the opentelemetry-helm-charts repository. More information is available in here.

Getting started

To install the operator in an existing cluster, make sure you have cert-manager installed and run:

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml

Once the opentelemetry-operator deployment is ready, create your first OpenTelemetry Collector instance. See Creating an OpenTelemetry Collector for the walkthrough.

Contributing

Please see CONTRIBUTING.md.

In addition to the core responsibilities the operator project requires approvers and maintainers to be responsible for releasing the project. See RELEASE.md for more information and release schedule.

Maintainers

• Benedikt Bongartz, Red Hat
• Jacob Aronoff, Omlet
• Mikołaj Świątek, Elastic
• Pavol Loffay, Red Hat

For more information about the maintainer role, see the community repository.

Approvers

• Antoine Toulme, Splunk
• Israel Blancas, Coralogix
• Tyler Helmuth, Honeycomb
• Yuri Oliveira Sa, OllyGarden

For more information about the approver role, see the community repository.

Triagers

For more information about the triager role, see the community repository.

Emeritus Maintainers

• Alex Boten
• Bogdan Drutu
• Juraci Paixão Kröhling
• Tigran Najaryan
• Vineeth Pothulapati

For more information about the emeritus role, see the community repository.

Emeritus Approvers

• Anthony Mirabella
• Dmitrii Anoshin
• James Bebbington
• Jay Camp
• Owais Lone
• Pablo Baeyens

For more information about the emeritus role, see the community repository.

Thanks to all the people who already contributed!

License

Apache 2.0 License.