loki.relabel
loki.relabel
组件通过应用一个或多个重新标记规则来重写传递到其接收器的每个日志条目的标签集,并将结果转发到组件参数中的接收器列表。
如果在应用重新标记规则后没有剩余标签,则会丢弃日志条目。
loki.relabel
最常见的用途是过滤日志条目或标准化传递到一个或多个下游接收器的标签集。配置的 rule
块按其在配置文件中出现的顺序应用于每个日志条目的标签集。可以通过调用 rules
导出字段中的函数来检索配置的规则。
如果您正在寻找处理日志条目内容的方法,请改用 loki.process
组件。
您可以通过为多个 loki.relabel
组件赋予不同的标签来指定它们。
用法
loki.relabel "<LABEL>" {
forward_to = <RECEIVER_LIST>
rule {
...
}
...
}
参数
您可以将以下参数与 loki.relabel
一起使用
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
forward_to | list(receiver) | 重新标记后将日志条目转发到何处。 | 是 | |
max_cache_size | int | 重新标记缓存中要保留的最大元素数量 | 10,000 | 否 |
块
您可以将以下块与 loki.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 | receiver | 日志行发送到此处进行重新标记的输入接收器。 |
rules | RelabelRules | 当前配置的重新标记规则。 |
组件运行状况
仅当 loki.relabel
配置无效时,才报告为不健康。在这些情况下,导出的字段将保留其最后一次健康的值。
调试信息
loki.relabel
不公开任何组件特定的调试信息。
调试指标
loki_relabel_entries_processed
(计数器): 处理的日志条目总数。loki_relabel_entries_written
(计数器): 转发的日志条目总数。loki_relabel_cache_misses
(计数器): 缓存未命中总数。loki_relabel_cache_hits
(计数器): 缓存命中总数。loki_relabel_cache_size
(仪表): 重新标记缓存的总大小。
示例
以下示例创建一个 loki.relabel
组件,该组件仅转发“level”值设置为“error”的条目。
loki.relabel "keep_error_only" {
forward_to = [loki.write.onprem.receiver]
rule {
action = "keep"
source_labels = ["level"]
regex = "error"
}
}
兼容组件
loki.relabel
可以接受来自以下组件的参数
- 导出 Loki
LogsReceiver
的组件
loki.relabel
具有可以被以下组件使用的导出
- 使用 Loki
LogsReceiver
的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。