Prune 过滤器插件
编辑Prune 过滤器插件编辑
- 插件版本: v3.0.4
- 发布日期: 2019-09-12
- 变更日志
有关其他版本，请参阅 版本化插件文档.
获取帮助编辑
如果您对插件有任何疑问，请在 Discuss 论坛中发布主题。对于错误或功能请求，请在 Github 中提交问题。有关 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵.
描述编辑
Prune 过滤器用于根据字段名称或值的黑白名单（名称和值也可以是正则表达式）从事件中删除字段。
例如，如果您有一个 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。
此过滤器目前仅支持对顶级字段的操作，即根据名称或值对子字段进行白名单和黑名单操作无效。
Prune 过滤器配置选项编辑
此插件支持以下配置选项，以及后面描述的 通用选项。
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
另请参阅 通用选项，了解所有过滤器插件支持的选项列表。
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。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 prune 过滤器。在这种情况下，添加一个命名 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（如果存在）。第二个示例还会删除一个令人沮丧的、不需要的标签。