diff --git a/docs/sources/mimir/configure/configure-otel-collector.md b/docs/sources/mimir/configure/configure-otel-collector.md index 26cd6f5c81..fb0e46d251 100644 --- a/docs/sources/mimir/configure/configure-otel-collector.md +++ b/docs/sources/mimir/configure/configure-otel-collector.md @@ -107,6 +107,41 @@ service: exporters: [..., prometheusremotewrite] ``` +## Work with default OpenTelemetry labels + +OpenTelemetry metrics use resource attributes to describe the set of characteristics associated with a given resource, or entity, producing telemetry data. For example, a host resource might have multiple attributes, including an ID, an image, and a type. + +To optimize the storage of and ability to query this data, you can configure Mimir to promote specified OTel resource attributes to labels at the time of ingestion, with periods (`.`) replaced by underscores (`_`). + +Grafana Cloud automatically promotes the following OTel resource attributes to labels: + +- `service.instance.id` +- `service.name` +- `service.namespace` +- `service.version` +- `cloud.availability_zone` +- `cloud region` +- `container.name` +- `deployment.environment.name` +- `k8s.cluster.name` +- `k8s.container.name` +- `k8s.cronjob.name` +- `k8s.daemonset.name` +- `k8s.deployment.name` +- `k8s.job.name` +- `k8s.namespace.name` +- `k8s.pod.name` +- `k8s.replicaset.name` +- `k8s.statefulset.name` + +{{< admonition type="note" >}} +To disable this setting or to update this list, contact Grafana Labs Support. +{{< /admonition >}} + +Mimir stores additional OTel resource attributes in a separate series called `target_info`, which you can query using a join query or the Prometheus `info()` function. Refer to [Functions](https://prometheus.io/docs/prometheus/latest/querying/functions/) in the Prometheus documentation for more information. + +To learn more about OpenTelemetry resource attributes, refer to [Resources](https://opentelemetry.io/docs/languages/js/resources/) in the OpenTelemetry documentation. + ## Format considerations We follow the official [OTLP Metric points to Prometheus](https://opentelemetry.io/docs/reference/specification/compatibility/prometheus_and_openmetrics/#otlp-metric-points-to-prometheus) specification.