Configure OBI Prometheus and OpenTelemetry data export

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

Estás viendo la versión en inglés de está página porque aún no ha sido traducida. ¿Te interesa ayudar? Mira en Contribuir.

OBI can export OpenTelemetry metrics and traces to a OTLP endpoint.

OpenTelemetry metrics exporter component

YAML section: otel_metrics_export

Enable the OpenTelemetry metrics export component by setting the endpoint attribute in your configuration file or via an environment variable, refer to metric export configuration options.

Configure the component under the otel_metrics_export section of your YAML configuration or via environment variables.

In addition to the configuration documented in this article, the component supports environment variables from the standard OpenTelemetry exporter configuration.

For example:

otel_metrics_export:
  ttl: 5m
  endpoint: http://otelcol:4318
  protocol: grpc
  features: ['network', 'network_inter_zone']
  buckets:
    duration_histogram: [0, 1, 2]
  histogram_aggregation: base2_exponential_bucket_histogram

YAML environment variable	Description	Type	Default
`endpoint` `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`	The endpoint OBI sends metrics to.	URL
`OTEL_EXPORTER_OTLP_ENDPOINT`	The shared endpoint for metrics and traces exporters. OBI adds `/v1/metrics` path to the URL when sending metrics, following the OpenTelemetry standard. To prevent this behavior, use the metrics specific setting.	URL
`protocol` `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL`	The protocol transport/encoding of the OpenTelemetry endpoint, refer to metrics export protocol. Accepted values `http/json`, `http/protobuf`, and `grpc`.	string	Inferred from port usage
`OTEL_EXPORTER_OTLP_PROTOCOL`	Similar to the shared endpoint, the protocol for metrics and traces.	string	Inferred from port usage
`insecure_skip_verify` `OTEL_EBPF_OTEL_INSECURE_SKIP_VERIFY`	If `true`, OBI skips verifying and accepts any server certificate. Only override this setting for non-production environments.	boolean	`false`
`interval` `OTEL_EBPF_METRICS_INTERVAL`	The duration between exports.	Duration	`60s`
`features` `OTEL_EBPF_OTEL_METRICS_FEATURES`	The list of metric groups OBI exports data for, refer to metrics export features. Accepted values `application`, `application_span`, `application_host`, `application_service_graph`, `application_process`, `network` and `network_inter_zone`.	list of strings	`["application"]`
`allow_service_graph_self_references` `OTEL_EBPF_OTEL_ALLOW_SERVICE_GRAPH_SELF_REFERENCES`	Controls if OBI includes self-referencing services in service graph generation, for example a service that calls itself. Self referencing reduces service graph usefulness and increases data cardinality.	boolean	`false`
`instrumentations` `OTEL_EBPF_OTEL_METRICS_INSTRUMENTATIONS`	The list of metrics instrumentation OBI collects data for, refer to metrics instrumentation section.	list of strings	`["*"]`
`buckets`	Sets how you can override bucket boundaries of diverse histograms, refer to override histogram buckets.	(n/a)	Object
`histogram_aggregation` `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION`	Sets the default aggregation OBI uses for histogram instruments. Accepted values `explicit_bucket_histogram` or `base2_exponential_bucket_histogram`.	`string`	`explicit_bucket_histogram`

Metrics export protocol

If you don’t set a protocol OBI sets the protocol as follows:

grpc: if the port ends in 4317, for example 4317, 14317, or 24317.
http/protobuf: if the port ends in 4318, for example 4318, 14318, or 24318.

Metrics export features

The OBI metrics exporter can export the following metrics data groups for processes matching entries in the metrics discovery configuration.

application: Application-level metrics
application_span Application-level trace span metrics
application_host Application-level host metrics for host based pricing
application_service_graph: Application-level service graph metrics. It’s recommended to use a DNS for service discovery and to ensure the DNS names match the OpenTelemetry service names OBI uses. In Kubernetes environments, the OpenTelemetry service name set by the service name discovery is the best choice for service graph metrics.
application_process: Metrics about the processes that runs the instrumented application
network: Network-level metrics, refer to the network metrics configuration documentation to learn more
network_inter_zone: Network inter-zone metrics, refer to the network metrics configuration documentation to learn more

Metrics instrumentation

The list of instrumentation areas OBI can collection data from:

*: all instrumentation, if * is present OBI ignores other values
http: HTTP/HTTPS/HTTP/2 application metrics
grpc: gRPC application metrics
sql: SQL database client call metrics
redis: Redis client/server database metrics
kafka: Kafka client/server message queue metrics

For example, setting the instrumentations option to: http,grpc enables the collection of HTTP/HTTPS/HTTP2 and gRPC application metrics, and disables other instrumentation.

OpenTelemetry traces exporter component

YAML section: otel_traces_export

You can configure the component under the otel_traces_export section of your YAML configuration or via environment variables.

In addition to the configuration documented in this article, the component supports the environment variables from the standard OpenTelemetry exporter configuration.

otel_traces_export:
  endpoint: http://jaeger:4317
  protocol: grpc
  instrumentations: ["http, "sql"]

YAML environment variable	Description	Type	Default
`endpoint` `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` `OTEL_EXPORTER_OTLP_ENDPOINT`	The endpoint OBI sends traces to. When using `OTEL_EXPORTER_OTLP_ENDPOINT`, OBI follows the OpenTelemetry standard and automatically adds `/v1/traces` path to the URL. If you don’t want this to happen, use the traces specific setting.	URL
`protocol` `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` `OTEL_EXPORTER_OTLP_PROTOCOL`	The protocol transport/encoding of the OpenTelemetry endpoint, refer to traces export protocol. Accepted values `http/json`, `http/protobuf`, and `grpc`.	string	Inferred from port usage
`insecure_skip_verify` `OTEL_EBPF_OTEL_INSECURE_SKIP_VERIFY`	If `true`, OBI skips verifying and accepts any server certificate. Only override this setting for non-production environments.	boolean	`false`
`instrumentations` `OTEL_EBPF_OTEL_TRACES_INSTRUMENTATIONS`	The list of instrumentation OBI collects data for, refer to traces instrumentation section.	list of strings	`["*"]`

Traces export protocol

If you don’t set a protocol OBI sets the protocol as follows:

grpc: if the port ends in 4317, for example 4317, 14317, or 24317.
http/protobuf: if the port ends in 4318, for example 4318, 14318, or 24318.

Traces instrumentation

The list of instrumentation areas OBI can collection data from:

*: all instrumentation, if * is present OBI ignores other values
http: HTTP/HTTPS/HTTP/2 application traces
grpc: gRPC application traces
sql: SQL database client call traces
redis: Redis client/server database traces
kafka: Kafka client/server message queue traces

For example, setting the instrumentations option to: http,grpc enables the collection of HTTP/HTTPS/HTTP2 and gRPC application traces, and disables other instrumentation.

Prometheus exporter component

YAML section: prometheus_export

You can configure the component under the prometheus_export section of your YAML configuration or via environment variables. This component opens an HTTP endpoint in the auto-instrumentation tool that allows any external scraper to pull metrics in Prometheus format. It is enabled if the port property is set.

prometheus_export:
  port: 8999
  path: /metrics
  extra_resource_attributes: ["deployment_environment"]
  ttl: 1s
  buckets:
    request_size_histogram: [0, 10, 20, 22]
    response_size_histogram: [0, 10, 20, 22]
  features:
    - application
    - network
    - application_process
    - application_span
    - application_service_graph
  instrumentations: ["http, "sql"]

YAML environment variable	Description	Type	Default
`port` `OTEL_EBPF_PROMETHEUS_PORT`	The HTTP port for the Prometheus scrape endpoint. If unset or 0, no Prometheus endpoint is open.	int
`path` `OTEL_EBPF_PROMETHEUS_PATH`	The HTTP query path to fetch the list of Prometheus metrics.	string	`/metrics`
`extra_resource_attributes` `OTEL_EBPF_PROMETHEUS_EXTRA_RESOURCE_ATTRIBUTES`	A list of additional resource attributes to be added to the reported `target_info` metric. Refer to extra resource attributes for important details about runtime discovered attributes.	list of strings
`ttl` `OTEL_EBPF_PROMETHEUS_TTL`	The duration after which metric instances are not reported if they haven’t been updated. Used to avoid reporting indefinitely finished application instances.	Duration	`5m`
`buckets`	Sets how you can override bucket boundaries of diverse histograms, refer to override histogram buckets.	Object
`features` `OTEL_EBPF_PROMETHEUS_FEATURES`	The list of metric groups OBI exports data for, refer to Prometheus export features.	list of strings	`["application"]`
`allow_service_graph_self_references` `OTEL_EBPF_PROMETHEUS_ALLOW_SERVICE_GRAPH_SELF_REFERENCES`	Does OBI include self-referencing service in service graph generation. Self referencing isn’t useful for service graphs and increases data cardinality.	boolean	`false`
`instrumentations` `OTEL_EBPF_PROMETHEUS_INSTRUMENTATIONS`	The list of instrumentation OBI collects data for, refer to Prometheus instrumentation section.	list of strings	`["*"]`

Prometheus extra resource attributes

Due to internal limitations of the Prometheus API client, OBI needs to know beforehand which attributes are exposed for each metric. This would cause that some attributes that are discovered at runtime, during instrumentation, won’t be visible by default. For example, attributes defined on each application via Kubernetes annotations, or in the target application’s OTEL_RESOURCE_ATTRIBUTES environment variable.

For example, an application defining the OTEL_RESOURCE_ATTRIBUTES=deployment.environment=production as environment variable, the target_info{deployment.environment="production"} attribute would be visible by default if the metrics are exported via OpenTelemetry but not if they are exported via Prometheus.

To make deployment_environment visible in Prometheus, you need to add it to the extra_resource_attributes list.

Prometheus export features

The Prometheus metrics exporter can export the following metrics data groups:

application: Application-level metrics
application_span: Application-level trace span metrics
application_host Application-level host metrics for host based pricing
application_service_graph: Application-level service graph metrics. It’s recommended to use a DNS for service discovery and to ensure the DNS names match the OpenTelemetry service names OBI uses. In Kubernetes environments, the OpenTelemetry service name set by the service name discovery is the best choice for service graph metrics.
application_process: Metrics about the processes that runs the instrumented application
network: Network-level metrics, refer to the network metrics configuration documentation to learn more
network_inter_zone: Network inter-zone metrics, refer to the network metrics configuration documentation to learn more

Prometheus instrumentation

The list of instrumentation areas OBI can collection data from:

*: all instrumentation, if * is present OBI ignores other values
http: HTTP/HTTPS/HTTP/2 application metrics
grpc: gRPC application metrics
sql: SQL database client call metrics
redis: Redis client/server database metrics
kafka: Kafka client/server message queue metrics

For example, setting the instrumentations option to: http,grpc enables the collection of HTTP/HTTPS/HTTP2 and gRPC application metrics, and disables other instrumentation.

Comentarios

¿Fue útil esta página?

Thank you. Your feedback is appreciated!

Please let us know how we can improve this page. Your feedback is appreciated!

Última modificación July 24, 2025: integrate grafana/beyla#2085 (7467f09f)