The CIDR filter is for checking IP addresses in events against a list of network blocks that might contain it. Multiple addresses can be checked against multiple networks, any match succeeds. Upon success additional tags and/or fields can be added to the event.
This plugin supports the following configuration options:
Required configuration options:
cidr {
}Available configuration options:
| Setting | Input type | Required | Default value |
|---|---|---|---|
No |
| ||
No |
| ||
No |
| ||
No |
| ||
No |
| ||
No |
| ||
No |
|
- Value type is hash
-
Default value is
{}
If this filter is successful, add any arbitrary fields to this event.
Field names can be dynamic and include parts of the event using the %{field}.
Example:
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"
}
}
}If the event has field "somefield" == "hello" this filter, on success,
would add field foo_hello if it is present, with the
value above and the %{host} piece replaced with that value from the
event. The second example would also add a hardcoded field.
- Value type is array
-
Default value is
[]
If this filter is successful, add arbitrary tags to the event.
Tags can be dynamic and include parts of the event using the %{field}
syntax.
Example:
filter {
cidr {
add_tag => [ "foo_%{somefield}" ]
}
}# You can also add multiple tags at once:
filter {
cidr {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}If the event has field "somefield" == "hello" this filter, on success,
would add a tag foo_hello (and the second example would of course add a taggedy_tag tag).
- Value type is array
-
Default value is
[]
The IP address(es) to check with. Example:
filter {
cidr {
add_tag => [ "testnet" ]
address => [ "%{src_ip}", "%{dst_ip}" ]
network => [ "192.0.2.0/24" ]
}
}- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without all/any (controlled by exclude_any config
option) of these tags.
Optional.
- Value type is array
-
Default value is
[]
The IP network(s) to check against. Example:
filter {
cidr {
add_tag => [ "linklocal" ]
address => [ "%{clientip}" ]
network => [ "169.254.0.0/16", "fe80::/64" ]
}
}- Value type is boolean
-
Default value is
false
Call the filter flush method at regular interval. Optional.
- Value type is array
-
Default value is
[]
If this filter is successful, remove arbitrary fields from this event. Example:
filter {
cidr {
remove_field => [ "foo_%{somefield}" ]
}
}# You can also remove multiple fields at once:
filter {
cidr {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}If the event has field "somefield" == "hello" this filter, on success,
would remove the field with name foo_hello if it is present. The second
example would remove an additional, non-dynamic field.
- Value type is array
-
Default value is
[]
If this filter is successful, remove arbitrary tags from the event.
Tags can be dynamic and include parts of the event using the %{field}
syntax.
Example:
filter {
cidr {
remove_tag => [ "foo_%{somefield}" ]
}
}# You can also remove multiple tags at once:
filter {
cidr {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}If the event has field "somefield" == "hello" this filter, on success,
would remove the tag foo_hello if it is present. The second example
would remove a sad, unwanted tag as well.
- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all/any (controlled by include_any config option) of these tags.
Optional.
- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
-
Default value is
""
Note that all of the specified routing options (type,tags,exclude_tags,include_fields,
exclude_fields) must be met in order for the event to be handled by the filter.
The type to act on. If a type is given, then this filter will only
act on messages with the same type. See any input plugin’s "type"
attribute for more.
Optional.