丢弃过滤器插件
编辑丢弃过滤器插件编辑
- 插件版本:v3.0.5
- 发布时间:2017 年 11 月 7 日
- 更新日志
有关其他版本,请参阅版本化插件文档。
获取帮助编辑
有关插件的问题,请在论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵。
描述编辑
丢弃过滤器。
丢弃传递到此过滤器的所有内容。
这最好与条件结合使用,例如
filter { if [loglevel] == "debug" { drop { } } }
仅当 loglevel 字段为debug
时,以上内容才会将事件传递到丢弃过滤器。这将导致所有匹配的事件都被丢弃。
通用选项编辑
以下配置选项受所有过滤器插件支持
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑
- 值类型为哈希
- 默认值为
{}
如果此过滤器成功,则向此事件添加任何任意字段。字段名称可以是动态的,并且可以使用%{field}
包含事件的一部分。
示例
filter { drop { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } }
# You can also add multiple fields at once: filter { drop { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } } }
如果事件的字段"somefield" == "hello"
,则此过滤器在成功时将添加字段foo_hello
(如果存在),其值为上述值,并将%{host}
部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag
编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则向事件添加任意标签。标签可以是动态的,并且可以使用%{field}
语法包含事件的一部分。
示例
filter { drop { add_tag => [ "foo_%{somefield}" ] } }
# You can also add multiple tags at once: filter { drop { add_tag => [ "foo_%{somefield}", "taggedy_tag"] } }
如果事件的字段"somefield" == "hello"
,则此过滤器在成功时将添加标签foo_hello
(当然,第二个示例将添加taggedy_tag
标签)。
id
编辑
- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的ID
。如果未指定 ID,Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时,例如,如果您有 2 个丢弃过滤器,这将特别有用。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter { drop { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,不支持使用密钥库中的值。
remove_field
编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并且可以使用 %{field} 示例
filter { drop { remove_field => [ "foo_%{somefield}" ] } }
# You can also remove multiple fields at once: filter { drop { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] } }
如果事件的字段"somefield" == "hello"
,则此过滤器在成功时将删除名称为foo_hello
的字段(如果存在)。第二个示例将删除另一个非动态字段。
remove_tag
编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并且可以使用%{field}
语法包含事件的一部分。
示例
filter { drop { remove_tag => [ "foo_%{somefield}" ] } }
# You can also remove multiple tags at once: filter { drop { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] } }
如果事件的字段"somefield" == "hello"
,则此过滤器在成功时将删除标签foo_hello
(如果存在)。第二个示例还将删除一个不需要的标签。