loki.relabel
loki.relabel
组件通过应用一个或多个重命名 rule
并将结果转发到组件参数中接收器的列表来重写每个传递给其接收器的日志条目的标签集。
如果在应用重命名规则后没有标签剩余,则删除日志条目。
使用 loki.relabel
的最常见用途是过滤日志条目或规范化传递给一个或多个下游接收器的标签集。这些 rule
块按它们在配置文件中出现的顺序应用于每个日志条目的标签集。可以通过调用 rules
导出字段中的函数来检索配置的规则。
如果您正在寻找处理日志条目内容的方法,请查看 loki.process
组件。
可以通过给它们不同的标签来指定多个 loki.relabel
组件。
用法
loki.relabel "LABEL" {
forward_to = RECEIVER_LIST
rule {
...
}
...
}
参数
以下是支持的参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
forward_to | list(receiver) | 在重命名后将日志条目转发到何处。 | yes | |
max_cache_size | int | 要在重命名缓存中保持的最大元素数 | 10,000 | no |
块
在 loki.relabel
的定义内部支持以下块
层阶 | 名称 | 描述 | 必需 |
---|---|---|---|
rule | rule | 应用于接收到的日志条目的重命名规则。 | no |
rule 块
该 rule
块包含可以应用于输入日志的重命名规则的定义。如果定义了多个 rule
块,则按从上到下的顺序应用这些转换。
可以使用以下参数来配置 rule
,所有参数都是可选的。省略的字段采用其默认值。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
action | string | 要执行的重命名操作。 | replace | no |
modulus | uint | 用于计算哈希源头标签值的模数的正整数。 | no | |
regex | string | 一个有效的 RE2 表达式,支持带括号的捕获组。用于匹配从 source_label 和 separator 字段组合中提取的值或在进行 labelkeep/labeldrop/labelmap 操作期间筛选标签。 | (.*) | no |
replacement | string | 如果正则表达式匹配提取的值,则对其进行正则表达式替换的值。支持先前捕获的组。 | "$1" | no |
separator | string | 用于连接 source_labels 中存在的值的分隔符。 | ; | no |
source_labels | list(string) | 要选择其值的标签列表。使用 separator 连接其内容,并与其匹配 regex 。 | no | |
target_label | string | 结果值写入的标签。 | no |
您可以使用以下操作:
drop
- 移除与使用source_labels
和separator
提取的字符串匹配的日志,其中regex
与之匹配。dropequal
- 移除source_labels
连接与target_label
不匹配的目标。hashmod
- 对连接的标签进行散列,计算其模数modulus
,并将结果写入target_label
。keep
- 保持与使用source_labels
和separator
提取的字符串匹配的日志,其中regex
与之匹配。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
的组件
注意
连接某些组件可能不合理或不合理,或组件可能需要进一步配置才能正确连接。请参阅相关文档获取更多详细信息。