`prometheus.relabel`

Prometheus 指标遵循 OpenMetrics 格式。每个时间序列由其指标名称以及可选的键值对（称为标签）唯一标识。每个样本代表时间序列中的一个数据点，包含一个值和可选的时间戳。

<metric name>{<label_1>=<label_val_1>, <label_2>=<label_val_2> ...} <value> [timestamp]

prometheus.relabel 组件通过应用一个或多个重新标记 (relabeling) rule 来重写传递给导出接收器的每个指标的标签集。如果没有定义规则或规则不适用于某些指标，则这些指标将按原样转发到组件参数中传递的每个接收器。如果在应用重新标记规则后没有剩余标签，则该指标将被丢弃。

prometheus.relabel 最常见的用途是过滤 Prometheus 指标或标准化传递给一个或多个下游接收器的标签集。rule 块按其在配置文件中出现的顺序应用于每个指标的标签集。配置的规则可以通过调用 rules 导出字段中的函数来检索。

您可以通过为 prometheus.relabel 组件指定不同的标签来使用多个实例。

用法

prometheus.relabel "<LABEL>" {
  forward_to = <RECEIVER_LIST>

  rule {
    ...
  }

  ...
}

参数

您可以使用以下参数配置 prometheus.relabel

名称	类型	描述	默认值	必需
`forward_to`	`list(MetricsReceiver)`	重新标记后，指标应转发到的位置。		是
`max_cache_size`	`int`	重新标记缓存中保留的最大元素数量。	100,000	否

块

您可以使用以下块配置 prometheus.relabel

名称	描述	必需
`rule`	应用于接收到的指标的重新标记规则。	否

`rule`

rule 块包含可应用于输入指标的任何重新标记规则的定义。如果定义了多个 rule 块，则转换将按自上而下的顺序应用。

以下参数可用于配置 rule。所有参数都是可选的。省略的字段采用其默认值。

名称	类型	描述	默认值	必需
`action`	`string`	要执行的重新标记操作。	replace	否
`modulus`	`uint`	一个正整数，用于计算哈希后的源标签值的模数。		否
`regex`	`string`	一个有效的 RE2 表达式，支持带括号的捕获组。用于匹配从 `source_label` 和 `separator` 字段组合中提取的值，或在 `labelkeep/labeldrop/labelmap` 操作期间过滤标签。	`(.*)`	否
`replacement`	`string`	用于执行正则表达式替换的值，如果正则表达式匹配提取的值。支持先前捕获的组。	`"$1"`	否
`separator`	`string`	用于连接 `source_labels` 中存在的值的分隔符。	;	否
`source_labels`	`list(string)`	要选择值的标签列表。它们的内容使用 `separator` 连接，并与 `regex` 进行匹配。		否
`target_label`	`string`	结果值将写入的标签。		否

您可以使用以下操作

drop - 删除 regex 与使用 source_labels 和 separator 提取的字符串匹配的指标。
dropequal - 删除连接后的 source_labels 与 target_label 不匹配的目标。
hashmod - 哈希连接的标签，计算其模数 modulus，并将结果写入 target_label。
keep - 保留 regex 与使用 source_labels 和 separator 提取的字符串匹配的指标。
keepequal - 删除连接后的 source_labels 与 target_label 匹配的目标。
labeldrop - 将 regex 与所有标签名称进行匹配。任何匹配的标签都将从指标的标签集中移除。
labelkeep - 将 regex 与所有标签名称进行匹配。任何不匹配的标签都将从指标的标签集中移除。
labelmap - 将 regex 与所有标签名称进行匹配。任何匹配的标签将根据 replacement 字段的内容重命名。
lowercase - 将 target_label 设置为连接后的 source_labels 的小写形式。
replace - 将 regex 与连接后的标签进行匹配。如果匹配，则使用 replacement 字段的内容替换 target_label 的内容。
uppercase - 将 target_label 设置为连接后的 source_labels 的大写形式。

注意
正则表达式捕获组可以使用 $CAPTURE_GROUP_NUMBER 或 ${CAPTURE_GROUP_NUMBER} 表示法引用。

导出字段

以下字段被导出，可供其他组件引用

名称	类型	描述
`receiver`	`MetricsReceiver`	输入接收器，样本将被发送到此接收器进行重新标记。
`rules`	`RelabelRules`	当前配置的重新标记规则。

组件健康状况

只有在配置无效时，prometheus.relabel 才会被报告为不健康。在这种情况下，导出字段将保持其上次健康时的值。

调试信息

prometheus.relabel 不公开任何组件特定的调试信息。

调试指标

prometheus_fanout_latency (直方图): 发送到直接和间接组件的写入延迟。
prometheus_forwarded_samples_total (计数器): 发送到下游组件的样本总数。
prometheus_relabel_cache_hits (计数器): 缓存命中总数。
prometheus_relabel_cache_misses (计数器): 缓存未命中总数。
prometheus_relabel_cache_size (计量器): 重新标记缓存的总大小。
prometheus_relabel_metrics_processed (计数器): 处理的指标总数。
prometheus_relabel_metrics_written (计数器): 写入的指标总数。

示例

以下示例展示了 prometheus.relabel 组件如何将重新标记规则应用于传入指标，并将结果转发到 prometheus.remote_write.onprem.receiver

prometheus.relabel "keep_backend_only" {
  forward_to = [prometheus.remote_write.onprem.receiver]

  rule {
    action        = "replace"
    source_labels = ["__address__", "instance"]
    separator     = "/"
    target_label  = "host"
  }
  rule {
    action        = "keep"
    source_labels = ["app"]
    regex         = "backend"
  }
  rule {
    action = "labeldrop"
    regex  = "instance"
  }
}

metric_a{__address__ = "localhost", instance = "development", app = "frontend"} 10
metric_a{__address__ = "localhost", instance = "development", app = "backend"}  2
metric_a{__address__ = "cluster_a", instance = "production",  app = "frontend"} 7
metric_a{__address__ = "cluster_a", instance = "production",  app = "backend"}  9
metric_a{__address__ = "cluster_b", instance = "production",  app = "database"} 4

应用第一个 rule 后，replace 操作通过连接 __address__ 和 instance 标签的内容（用斜杠 / 分隔）来填充一个名为 host 的新标签。

metric_a{host = "localhost/development", __address__ = "localhost", instance = "development", app = "frontend"} 10
metric_a{host = "localhost/development", __address__ = "localhost", instance = "development", app = "backend"}  2
metric_a{host = "cluster_a/production",  __address__ = "cluster_a", instance = "production",  app = "frontend"} 7
metric_a{host = "cluster_a/production",  __address__ = "cluster_a", instance = "production",  app = "backend"}  9
metric_a{host = "cluster_b/production",  __address__ = "cluster_a", instance = "production",  app = "database"} 4

在第二个重新标记规则中，keep 操作只保留 app 标签匹配 regex 的指标，丢弃其他所有指标，因此指标列表被修剪为

metric_a{host = "localhost/development", __address__ = "localhost", instance = "development", app = "backend"}  2
metric_a{host = "cluster_a/production",  __address__ = "cluster_a", instance = "production",  app = "backend"}  9

第三个也是最后一个重新标记规则使用 labeldrop 操作从标签集中移除 instance 标签。

因此，在这种情况下，传递给导出接收器的初始指标集是

metric_a{host = "localhost/development", __address__ = "localhost", app = "backend"}  2
metric_a{host = "cluster_a/production",  __address__ = "cluster_a", app = "backend"}  9

然后将生成的两个指标传播到 forward_to 参数中定义的每个接收器。