修剪过滤器插件
编辑修剪过滤器插件
编辑- 插件版本: v3.0.4
- 发布日期: 2019-09-12
- 更新日志
对于其他版本，请参阅版本化插件文档。
获取帮助
编辑如有关于插件的问题，请在Discuss论坛中开一个主题。如有错误或功能请求，请在Github中开一个 issue。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。
描述
编辑修剪过滤器用于根据字段名称或其值的白名单或黑名单（名称和值也可以是正则表达式）从事件中删除字段。
例如，如果您有一个json或kv过滤器，该过滤器创建了许多您不一定事先知道名称的字段，并且您只想保留其中的一部分，这可能很有用。
使用帮助：要指定确切的字段名称或值，请使用正则表达式语法^some_name_or_value$。用法示例：输入数据{ "msg":"hello world", "msg_short":"hw" }
filter {
prune {
whitelist_names => [ "msg" ]
}
}
Allows both `"msg"` and `"msg_short"` through.
而
filter {
prune {
whitelist_names => ["^msg$"]
}
}
Allows only `"msg"` through.
Logstash 将事件的 tags 存储为一个字段，该字段可以进行修剪。请记住使用 whitelist_names => [ "^tags$" ] 在修剪后保留 tags，或者使用 blacklist_values => [ "^tag_name$" ] 来消除特定的 tag。
此过滤器目前仅支持对顶级字段进行操作，即基于名称或值的子字段的白名单和黑名单不起作用。
修剪过滤器配置选项
编辑此插件支持以下配置选项以及稍后描述的通用选项。
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
另请参阅通用选项，以获取所有过滤器插件支持的选项列表。
blacklist_names
编辑- 值类型为数组
- 默认值为
["%{[^}]+}"]
排除名称与指定正则表达式匹配的字段，默认情况下排除未解析的%{field}字符串。
filter {
prune {
blacklist_names => [ "method", "(referrer|status)", "${some}_field" ]
}
}
blacklist_values
编辑- 值类型为哈希
- 默认值为
{}
如果指定字段的值与提供的正则表达式之一匹配，则排除指定字段。如果字段值为数组，则将每个数组项与正则表达式进行匹配，并且将排除匹配的数组项。
filter {
prune {
blacklist_values => [ "uripath", "/index.php",
"method", "(HEAD|OPTIONS)",
"status", "^[^2]" ]
}
}
通用选项
编辑所有过滤器插件都支持这些配置选项
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑- 值类型为哈希
- 默认值为
{}
如果此过滤器成功，则将任何任意字段添加到此事件。字段名称可以是动态的，并使用%{field}包含事件的一部分。
示例
filter {
prune {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
prune {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时，如果存在字段foo_hello，则会添加该字段，其值如上所示，并且%{host}部分将替换为事件中的值。第二个示例还将添加一个硬编码字段。
add_tag
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并使用%{field}语法包含事件的一部分。
示例
filter {
prune {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
prune {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时将添加标签foo_hello（第二个示例当然会添加taggedy_tag标签）。
id
编辑- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID。如果未指定 ID，则 Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有 2 个修剪过滤器。在这种情况下，添加命名的 ID 将有助于在使用监控 API 时监控 Logstash。
filter {
prune {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用来自秘密存储的值。
remove_field
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并使用 %{field} 包含事件的一部分。示例
filter {
prune {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
prune {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时，如果存在名为foo_hello的字段，则会删除该字段。第二个示例将删除一个额外的非动态字段。
remove_tag
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意标签。标签可以是动态的，并使用%{field}语法包含事件的一部分。
示例
filter {
prune {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
prune {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时，如果存在标签foo_hello，则会删除该标签。第二个示例还会删除一个令人沮丧、不需要的标签。