Configure the Beyla internal metrics reporter
You are viewing the English version of this page because it has not yet been fully translated. Interested in helping out? See Contributing.
Configure the Beyla internal metrics reporter
YAML section: internal_metrics
This component reports internal metrics about the auto-instrumentation tool’s behavior. You can export these metrics using Prometheus or OpenTelemetry.
To export metrics with Prometheus, set exporter
to prometheus
in the
internal_metrics
section. Then set port
in the prometheus
subsection.
To export metrics with OpenTelemetry, set exporter
to otel
in the
internal_metrics
section. Then set an endpoint in the otel_metrics_export
or
grafana.otlp
section.
Example:
internal_metrics:
exporter: prometheus
prometheus:
port: 6060
path: /internal/metrics
Configuration summary
YAML | Environment Variable | Type | Default | Summary |
---|---|---|---|---|
exporter | BEYLA_INTERNAL_METRICS_EXPORTER | string | disabled | Selects the internal metrics exporter. |
prometheus.port | BEYLA_INTERNAL_METRICS_PROMETHEUS_PORT | int | (unset) | HTTP port for Prometheus scrape endpoint. |
prometheus.path | BEYLA_INTERNAL_METRICS_PROMETHEUS_PATH | string | /internal/metrics | HTTP query path for Prometheus metrics. |
exporter
Set the internal metrics exporter. You can use disabled
, prometheus
, or
otel
.
prometheus.port
Set the HTTP port for the Prometheus scrape endpoint. If you leave it unset or set it to 0, Beyla doesn’t open a Prometheus endpoint and doesn’t report metrics.
You can use the same value as
prometheus_export.port
(both
metric families share the same HTTP server, but use different paths), or use a
different value (Beyla opens two HTTP servers for the different metric
families).
prometheus.path
Set the HTTP query path to fetch Prometheus metrics.
If prometheus_export.port
and
internal_metrics.prometheus.port
use the same value, you can set
internal_metrics.prometheus.path
to a different value than
prometheus_export.path
to keep the metric families separate, or use the same
value to list both metric families in the same scrape endpoint.
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!