For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
This filter appears to rename fields by replacing .
characters with a differentseparator. In reality, it’s a somewhat expensive filter that has to copy thesource field contents to a new destination field (whose name no longer containsdots), and then remove the corresponding source field.
It should only be used if no other options are available.
This plugin supports the following configuration options plus the Common Options described later.
Also see Common Options for a list of options supported by allfilter plugins.
The fields
array should contain a list of known fields to act on.If undefined, all top-level fields will be checked. Sub-fields must bemanually specified in the array. For example: ["field.suffix","[foo][bar.suffix]"]
will result in "field_suffix" and nested or sub field ["foo"]["bar_suffix"]
This is an expensive operation.
false
If nested
is true, then create sub-fields instead of replacing dots witha different separator.
The following configuration options are supported by all filter plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
{}
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 { de_dot { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } }}
# You can also add multiple fields at once:filter { de_dot { 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 thevalue above and the %{host}
piece replaced with that value from theevent. The second example would also add a hardcoded field.
[]
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 { de_dot { add_tag => [ "foo_%{somefield}" ] }}
# You can also add multiple tags at once:filter { de_dot { 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).
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type, for example, if you have 2 de_dot filters.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
filter { de_dot { id => "ABC" }}
false
Call the filter flush method at regular interval.Optional.
[]
If this filter is successful, remove arbitrary fields from this event.Example:
filter { de_dot { remove_field => [ "foo_%{somefield}" ] }}
# You can also remove multiple fields at once:filter { de_dot { 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 secondexample would remove an additional, non-dynamic field.
[]
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 { de_dot { remove_tag => [ "foo_%{somefield}" ] }}
# You can also remove multiple tags at once:filter { de_dot { 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 examplewould remove a sad, unwanted tag as well.