菜单
开源

loki.relabel

loki.relabel 组件通过应用一个或多个重命名规则,重写每个日志条目的标签集,并将其转发到组件参数中的接收器列表。

如果应用重命名规则后没有标签剩下,则删除日志条目。

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

如果您正在寻找处理日志条目内容的方法,请查看 loki.process 组件

可以通过指定不同的标签来指定多个 loki.relabel 组件。

用法

alloy
loki.relabel "LABEL" {
  forward_to = RECEIVER_LIST

  rule {
    ...
  }

  ...
}

参数

支持以下参数

名称类型描述默认值必需
forward_tolist(receiver)重新标签后,将日志条目转发到何处。yes
max_cache_sizeint在重新标签缓存中保留的最大元素数10,000no

loki.relabel 定义内支持以下块

层次结构名称描述必需
rulerule应用于接收到的日志条目的重新标签规则。no

rule 块

rule 块包含可以应用于输入日志的任何重新标签规则的定义。如果定义了多个 rule 块,则按从上到下的顺序应用转换。

您可以使用以下参数来配置 rule。所有参数都是可选的。省略的字段将采用它们的默认值。

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

您可以使用以下操作

  • drop - 删除其中 regex 匹配使用 source_labelsseparator 提取的字符串的日志。
  • dropequal - 删除目标 source_labelstarget_label 匹配的条目。
  • hashmod - 散列连接的标签,计算其模数 modulus,并将结果写入 target_label
  • keep - 保留其中 regex 匹配使用 source_labelsseparator 提取的字符串的日志。
  • keepequal - 删除目标 source_labelstarget_label 不匹配的条目。
  • labeldrop - 将 regex 与所有标签名称匹配。任何匹配的标签都将从日志的标签集中删除。
  • labelkeep - 将 regex 与所有标签名称匹配。任何不匹配的标签都将从日志的标签集中删除。
  • labelmap - 将正则表达式与所有标签名称进行匹配。任何匹配的标签都将根据replacement字段的 内容进行重命名。
  • lowercase - 将target_label设置为连接的source_labels的小写形式。
  • replace - 将正则表达式与连接的标签进行匹配。如果匹配成功,则使用replacement字段的内容替换target_label的内容。
  • uppercase - 将target_label设置为连接的source_labels的大写形式。

注意

可以使用$CAPTURE_GROUP_NUMBER${CAPTURE_GROUP_NUMBER}符号来引用正则表达式捕获组。

导出字段

以下字段被导出,并可被其他组件引用

名称类型描述
receiverreceiver日志行被发送到该输入接收器进行重标签。
rulesRelabelRules当前配置的重命名规则。

组件健康状态

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'的条目。

alloy
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的组件

注意

连接某些组件可能不合理,或者组件可能需要进一步配置才能正确连接。请参阅链接文档以获取更多详细信息。