opentelemetry-packaging

module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2026 License: Apache-2.0

README

OpenTelemetry Packaging

The Packaging SIG delivers a streamlined, product-like experience for monitoring applications on virtual Linux hosts. It combines the OpenTelemetry Injector, OpenTelemetry eBPF Instrumentation (OBI), and the OpenTelemetry Collector into modular system packages. Users can achieve observability through a single command:

{apt|yum} install opentelemetry

Installing

Each release publishes APT and YUM repositories on GitHub Pages, together with a landing page that carries the complete installation instructions, including selective per-language installs.

[!NOTE] The GitHub Pages hosting is an interim solution, and the repository URLs below will change when the packages move to their permanent distribution infrastructure.

On Debian and Ubuntu, add the APT repository:

echo "deb [trusted=yes] https://open-telemetry.github.io/opentelemetry-packaging/debian stable main" | sudo tee /etc/apt/sources.list.d/opentelemetry.list

Refresh the package index:

sudo apt update

Install the full auto-instrumentation suite:

sudo apt install opentelemetry

On Fedora, RHEL, and derivatives, add the YUM repository:

cat <<EOF | sudo tee /etc/yum.repos.d/opentelemetry.repo
[opentelemetry]
name=OpenTelemetry Auto-Instrumentation System Packages
baseurl=https://open-telemetry.github.io/opentelemetry-packaging/rpm/packages
enabled=1
gpgcheck=0
EOF

Install the full auto-instrumentation suite:

sudo dnf install opentelemetry

Current scope

Scope as defined by the approved System Packages project.

Infrastructure and packaging
  • Establish APT and RPM repository infrastructure for OpenTelemetry packages
  • Publish modular system packages for the Injector, OBI, and language-specific auto-instrumentation (Java, .NET, Node.js, Python)
  • Integrate existing OpenTelemetry Collector packages into repositories
  • Define versioning policies aligned with Debian, Ubuntu, and Red Hat practices
Design principles
  • Make declarative configuration a foundational element.
  • Enable vendor packages to provide alternatives to upstream offerings.
  • Ensure OBI and the Injector operate cohesively without double instrumentation.
  • Adhere to Filesystem Hierarchy Standard (FHS) and packaging best practices.
Out of scope
  • Operating systems beyond Debian and RHEL derivatives.
  • Profilers integration.
  • Container image building.

Contributing

For more details on the project proposal, see the community project page.

SIG meetings (minutes) are held weekly on Wednesdays at 10 AM PT.

Maintainers

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

Approvers

  • TODO

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

Directories

Path Synopsis
cmd
build-packages command
Command build-packages creates OpenTelemetry DEB and RPM packages using nfpm.
Command build-packages creates OpenTelemetry DEB and RPM packages using nfpm.
otel-config-check command
otel-config-check validates an OpenTelemetry declarative configuration file for use with the Python auto-instrumentation package.
otel-config-check validates an OpenTelemetry declarative configuration file for use with the Python auto-instrumentation package.
packaging
builder
Package builder creates OpenTelemetry DEB and RPM packages using nfpm.
Package builder creates OpenTelemetry DEB and RPM packages using nfpm.
Package testutil provides shared helpers for packaging integration tests.
Package testutil provides shared helpers for packaging integration tests.
otelsink
Package otelsink provides an in-process OTLP sink for integration tests.
Package otelsink provides an in-process OTLP sink for integration tests.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL