Cidr 过滤器插件
编辑Cidr 过滤器插件
编辑- 插件版本: v3.1.3
- 发布日期: 2019-09-18
- 更新日志
对于其他版本,请参阅版本化的插件文档。
获取帮助
编辑如有关于此插件的问题,请在Discuss论坛中开启一个主题。如有错误或功能请求,请在Github中开启一个 issue。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵。
描述
编辑CIDR 过滤器用于根据可能包含事件的 IP 地址的网络块列表检查事件中的 IP 地址。可以针对多个网络检查多个地址,任何匹配都会成功。成功后,可以将其他标签和/或字段添加到事件中。
Cidr 过滤器配置选项
编辑此插件支持以下配置选项以及稍后描述的通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
有效的的文件系统路径 |
否 |
|
否 |
||
否 |
另请参阅通用选项,了解所有过滤器插件支持的选项列表。
address
编辑- 值类型是数组
- 默认值是
[]
要检查的 IP 地址。 示例
filter { cidr { add_tag => [ "testnet" ] address => [ "%{src_ip}", "%{dst_ip}" ] network => [ "192.0.2.0/24" ] } }
network
编辑- 值类型是数组
- 默认值是
[]
要检查的网络 IP 地址。示例
filter { cidr { add_tag => [ "linklocal" ] address => [ "%{clientip}" ] network => [ "169.254.0.0/16", "fe80::/64" ] } }
通用选项
编辑所有过滤器插件都支持这些配置选项
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑- 值类型是哈希
- 默认值是
{}
如果此过滤器成功,请将任何任意字段添加到此事件。 字段名称可以是动态的,并且可以使用 %{field}
包含事件的部分内容。
示例
filter { cidr { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } }
# You can also add multiple fields at once: filter { cidr { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时,如果存在,将添加字段foo_hello
,其值为上述值,并且%{host}
部分将替换为事件中的该值。 第二个示例还将添加一个硬编码的字段。
add_tag
编辑- 值类型是数组
- 默认值是
[]
如果此过滤器成功,请向事件添加任意标签。 标签可以是动态的,并且可以使用 %{field}
语法包含事件的部分内容。
示例
filter { cidr { add_tag => [ "foo_%{somefield}" ] } }
# You can also add multiple tags at once: filter { cidr { add_tag => [ "foo_%{somefield}", "taggedy_tag"] } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时将添加一个标签foo_hello
(第二个示例当然会添加一个taggedy_tag
标签)。
id
编辑- 值类型是字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID
。 如果未指定 ID,则 Logstash 将生成一个 ID。 强烈建议在配置中设置此 ID。 当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有 2 个 cidr 过滤器。 在这种情况下添加命名 ID 将有助于在使用监视 API 时监视 Logstash。
filter { cidr { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。
remove_field
编辑- 值类型是数组
- 默认值是
[]
如果此过滤器成功,则从此事件中删除任意字段。 字段名称可以是动态的,并且可以使用 %{field} 包含事件的部分内容。示例
filter { cidr { remove_field => [ "foo_%{somefield}" ] } }
# You can also remove multiple fields at once: filter { cidr { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时,如果存在,将删除名称为 foo_hello
的字段。 第二个示例将删除一个额外的非动态字段。
remove_tag
编辑- 值类型是数组
- 默认值是
[]
如果此过滤器成功,则从此事件中删除任意标签。 标签可以是动态的,并且可以使用 %{field}
语法包含事件的部分内容。
示例
filter { cidr { remove_tag => [ "foo_%{somefield}" ] } }
# You can also remove multiple tags at once: filter { cidr { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] } }
如果事件具有字段"somefield" == "hello"
,则此过滤器在成功时,如果存在,将删除标签 foo_hello
。 第二个示例还将删除一个不想要的标签。