分割过滤器插件
编辑分割过滤器插件
编辑- 插件版本：v3.1.8
- 发布日期：2020-01-21
- 更新日志
其他版本，请查看 版本化插件文档。
获取帮助
编辑如有任何关于插件的问题，请在 Discuss 论坛中发帖提问。如发现错误或有功能需求，请在 Github 上提交 issue。如需查看 Elastic 支持的插件列表，请查阅 Elastic 支持矩阵。
描述
编辑分割过滤器通过分割其字段之一并将分割产生的每个值放入原始事件的副本中来克隆事件。被分割的字段可以是字符串或数组。
此过滤器的用例示例是从 exec 输入插件 获取输出，该插件为命令的整个输出发出一个事件，并按换行符分割该输出——使每一行成为一个事件。
分割过滤器也可用于将事件中的数组字段拆分为单个事件。JSON 和 XML 中非常常见的模式是使用列表将数据组合在一起。
例如，这样的 JSON 结构
{ field1: ...,
results: [
{ result ... },
{ result ... },
{ result ... },
...
] }
分割过滤器可用于上述数据，为 results 字段的每个值创建单独的事件。
filter {
split {
field => "results"
}
}
每次分割的最终结果是事件的完整副本，只有给定字段的当前分割部分发生更改。
通用选项
编辑所有过滤器插件都支持这些配置选项
| 设置 | 输入类型 | 必填 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑- 值类型为 hash
- 默认值为
{}
如果此过滤器成功，则将任意字段添加到此事件。字段名称可以是动态的，并包含使用 %{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} 部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag
编辑- 值类型为 array
- 默认值为
[]
如果此过滤器成功，则向事件添加任意标签。标签可以是动态的，并包含使用 %{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 将有助于使用监控 API 监控 Logstash。
filter {
split {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。
remove_field
编辑- 值类型为 array
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并包含使用 %{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 的字段。第二个示例将删除另一个非动态字段。
remove_tag
编辑- 值类型为 array
- 默认值为
[]
如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并包含使用 %{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。第二个示例还将删除一个令人不快的、不需要的标签。