Cidr 过滤器插件
编辑Cidr 过滤器插件编辑
- 插件版本：v3.1.3
- 发布日期：2019-09-18
- 变更日志
有关其他版本，请参阅 版本化插件文档。
获取帮助编辑
如果您对插件有任何疑问，请在 Discuss 论坛中发布主题。对于错误或功能请求，请在 Github 中打开问题。有关 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵。
描述编辑
CIDR 过滤器用于检查事件中的 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编辑
- 值类型为 hash
- 默认值为
{}
如果此过滤器成功，则向此事件添加任何任意字段。字段名称可以是动态的，并使用 %{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。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 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（如果存在）。第二个示例还将删除一个令人悲伤的、不需要的标签。