Java_uuid filter plugin
Logstash Core Plugin. The java_uuid filter plugin cannot be installed or uninstalled independently of Logstash.
For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub.
The uuid filter allows you to generate aUUID and add it as a field to each processed event.
This is useful if you need to generate a string that’s unique for every event even if the same input is processed multiple times. If you want to generate strings that are identical each time an event with the same content is processed (i.e., a hash), you should use thefingerprint filter instead.
The generated UUIDs follow the version 4 definition inRFC 4122 and will be represented in standard hexadecimal string format, e.g. "e08806fe-02af-406c-bbde-8a5ae4475e57".
This plugin supports the following configuration options plus theCommon options described later.
Also seeCommon options for a list of options supported by all filter plugins.
- Value type isboolean
- Default value is
false
Determines if an existing value in the field specified by thetarget
option should be overwritten by the filter.
Example:
filter { java_uuid { target => "uuid" overwrite => true }}
- This is a required setting.
- Value type isstring
- There is no default value for this setting.
Specifies the name of the field in which the generated UUID should be stored.
Example:
filter { java_uuid { target => "uuid" }}
These configuration options are supported by all filter plugins:
Setting | Input type | Required |
---|---|---|
add_field | hash | No |
add_tag | array | No |
enable_metric | boolean | No |
id | string | No |
periodic_flush | boolean | No |
remove_field | array | No |
remove_tag | array | No |
- Value type ishash
- 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 { java_uuid { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } }}
# You can also add multiple fields at once:filter { java_uuid { 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 fieldfoo_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 isarray
- 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 { java_uuid { add_tag => [ "foo_%{somefield}" ] }}
# You can also add multiple tags at once:filter { java_uuid { add_tag => [ "foo_%{somefield}", "taggedy_tag"] }}
If the event has field"somefield" == "hello"
this filter, on success, would add a tagfoo_hello
(and the second example would of course add ataggedy_tag
tag).
- Value type isboolean
- Default value is
true
Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
- Value type isstring
- There is no default value for this setting.
Add a uniqueID
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 useful when you have two or more plugins of the same type, for example, if you have 2 java_uuid filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
filter { java_uuid { id => "ABC" }}
Variable substitution in theid
field only supports environment variables and does not support the use of values from the secret store.
- Value type isboolean
- Default value is
false
Call the filter flush method at regular interval. Optional.
- Value type isarray
- Default value is
[]
If this filter is successful, remove arbitrary fields from this event. Fields names can be dynamic and include parts of the event using the%{{field}}
Example:
filter { java_uuid { remove_field => [ "foo_%{somefield}" ] }}
# You can also remove multiple fields at once:filter { java_uuid { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] }}
If the event has field"somefield" == "hello"
this filter, on success, would remove the field with namefoo_hello
if it is present. The second example would remove an additional, non-dynamic field.
- Value type isarray
- 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 { java_uuid { remove_tag => [ "foo_%{somefield}" ] }}
# You can also remove multiple tags at once:filter { java_uuid { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] }}
If the event has field"somefield" == "hello"
this filter, on success, would remove the tagfoo_hello
if it is present. The second example would remove a sad, unwanted tag as well.