Configure OBI

Learn how to configure OBI.

You are viewing the English version of this page because it has not yet been fully translated. Interested in helping out? See Contributing.

You can configure OBI by setting export modes, global properties, and component options.

For information on the metrics OBI exports, refer to the exported metrics documentation.

Refer to the routes decorator documentation to configure the low cardinality routes decorator. It’s very important for optimal results.

Configuration versions

Use Config v2 with OBI v0.11.0 and later. It works with standalone OBI and the OBI Collector receiver, uses the OpenTelemetry declarative configuration structure for common settings, and places OBI-specific settings under extensions.obi.

Unless otherwise noted, the other pages in this section describe Config v1. Each page links to the corresponding Config v2 guidance.


Configure OBI export modes

Configure OBI to export data directly to an OTLP endpoint

OBI global configuration properties

Configure global configuration properties that apply to OBI core.

OBI Config v2 reference

Learn how to configure standalone OBI or the OBI Collector receiver with Config v2.

Migrate from OBI Config v1 to Config v2

Learn how to safely migrate an OBI Config v1 file to Config v2.

Configure OBI Prometheus and OpenTelemetry data export

Configure the OBI components to export Prometheus and OpenTelemetry metrics and OpenTelemetry traces

Configure OBI service discovery

Configure how the OBI service discovery component searches for processes to instrument.

Configure OBI metrics and traces attributes

Configure the metrics and traces attributes component that controls the attributes reported, including instance ID decoration and metadata of instrumented Kubernetes pods.

Filter metrics and traces by attribute values

Configure OBI to filter metrics and traces by attribute values.

Configure OBI routes decorator

Configure the routes decorator component before OBI sends data to the next stage of the pipeline.

Configure OBI Prometheus and OpenTelemetry metrics histograms

Configure metrics histograms for Prometheus and OpenTelemetry, and whether to use native histograms and exponential histograms.

Configure OBI OpenTelemetry trace sampling

Configure how to sample OpenTelemetry traces.

OBI as OpenTelemetry Collector receiver

Learn how to use OBI as a receiver component in the OpenTelemetry Collector for centralized telemetry processing.

Configure the OBI internal metrics reporter

Configure how the optional internal metrics reporter component reports metrics on the internal behavior of the auto-instrumentation tool in Prometheus format.

Configure OBI performance

Configure how the eBPF tracer component instruments HTTP and GRPC services of external processes and creates traces to forward to the next stage of the pipeline.

OBI Config v1 YAML example

Example Config v1 YAML file for OBI.


Ostatnia modyfikacja August 24, 2026: Document OBI v0.12.1 (#11356) (2021ec6e)