拆分过滤器插件编辑

  • 插件版本:v3.1.8
  • 发布时间:2020 年 1 月 21 日
  • 更新日志

有关其他版本,请参阅版本化插件文档

获取帮助编辑

如果您对该插件有任何疑问,请在论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述编辑

拆分过滤器通过拆分事件的一个字段并将其拆分后的每个值放入原始事件的克隆中来克隆事件。被拆分的字段可以是字符串或数组。

此过滤器的一个用例是从exec 输入插件获取输出,该插件为命令的整个输出发出一个事件,并按换行符拆分该输出 - 使每一行成为一个事件。

拆分过滤器还可以用于将事件中的数组字段拆分为单个事件。JSON 和 XML 中非常常见的模式是使用列表将数据分组在一起。

例如,像这样的 JSON 结构

{ field1: ...,
 results: [
   { result ... },
   { result ... },
   { result ... },
   ...
] }

拆分过滤器可用于上述数据,为results字段的每个值创建单独的事件

filter {
 split {
   field => "results"
 }
}

每次拆分的最终结果是事件的完整副本,只有给定字段的当前拆分部分发生了变化。

拆分过滤器配置选项编辑

此插件支持以下配置选项以及稍后描述的通用选项

设置 输入类型 必需

字段

字符串

目标

字符串

分隔符

字符串

另请参阅通用选项,了解所有过滤器插件支持的选项列表。

 

字段编辑

其值由分隔符拆分的字段。可以是多行消息或数组的 ID。嵌套数组的引用方式如下:[对象 ID][数组 ID]

目标编辑

  • 值类型为字符串
  • 此设置没有默认值。

新事件中将值拆分到的字段。如果未设置,则目标字段默认为拆分字段名称。

分隔符编辑

要拆分的字符串。这通常是行终止符,但可以是任何字符串。如果要将 JSON 数组拆分为多个事件,则可以忽略此字段。

通用选项编辑

以下配置选项受所有过滤器插件支持

添加字段编辑

  • 值类型为哈希
  • 默认值为{}

如果此过滤器成功,请向此事件添加任何任意字段。字段名称可以是动态的,并且可以使用%{field}包含事件的一部分。

示例

    filter {
      split {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }
    # You can also add multiple fields at once:
    filter {
      split {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

如果事件的字段"somefield" == "hello",则此过滤器在成功时将添加字段foo_hello(如果存在),其值为上述值,并将%{host}部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。

添加标签编辑

  • 值类型为数组
  • 默认值为[]

如果此过滤器成功,请向事件添加任意标签。标签可以是动态的,并且可以使用%{field}语法包含事件的一部分。

示例

    filter {
      split {
        add_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also add multiple tags at once:
    filter {
      split {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

如果事件的字段"somefield" == "hello",则此过滤器在成功时将添加标签foo_hello(当然,第二个示例将添加taggedy_tag标签)。

启用指标编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

ID编辑

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的ID。如果未指定 ID,Logstash 将生成一个 ID。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时,例如,如果您有两个拆分过滤器,这将特别有用。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

    filter {
      split {
        id => "ABC"
      }
    }

id字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。

定期刷新编辑

定期调用过滤器刷新方法。可选。

删除字段编辑

  • 值类型为数组
  • 默认值为[]

如果此过滤器成功,请从此事件中删除任意字段。字段名称可以是动态的,并且可以使用%{field}示例

    filter {
      split {
        remove_field => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple fields at once:
    filter {
      split {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

如果事件的字段"somefield" == "hello",则此过滤器在成功时将删除名称为foo_hello的字段(如果存在)。第二个示例将删除一个额外的非动态字段。

删除标签编辑

  • 值类型为数组
  • 默认值为[]

如果此过滤器成功,请从事件中删除任意标签。标签可以是动态的,并且可以使用%{field}语法包含事件的一部分。

示例

    filter {
      split {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple tags at once:
    filter {
      split {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

如果事件的字段"somefield" == "hello",则此过滤器在成功时将删除标签foo_hello(如果存在)。第二个示例还将删除一个不需要的标签。