Drop 过滤器插件
编辑Drop 过滤器插件
编辑- 插件版本: v3.0.5
- 发布日期: 2017-11-07
- 更新日志
对于其他版本，请参阅版本化插件文档。
获取帮助
编辑有关该插件的问题，请在Discuss论坛中开一个主题。对于错误或功能请求，请在Github中开一个 issue。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。
描述
编辑Drop 过滤器。
丢弃所有到达此过滤器的事件。
这最好与条件语句结合使用，例如
filter {
if [loglevel] == "debug" {
drop { }
}
}
上述配置仅在 loglevel 字段为 debug 时才将事件传递给 drop 过滤器。这将导致所有匹配的事件都被丢弃。
通用选项
编辑所有过滤器插件都支持这些配置选项
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
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。当您有两个或多个相同类型的插件时，此功能特别有用，例如，如果您有两个 drop 过滤器。在这种情况下添加一个命名的 ID 将有助于在使用监视 API 时监视 Logstash。
filter {
drop {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用来自 secret store 的值。
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。第二个示例也将删除一个令人不快的、不需要的标签。