fingerprint
editfingerprint
edit- Version: 3.0.2
- Released on: July 14, 2016
- Changelog
Getting Help
editFor 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.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
fingerprint { method => ... }
Available configuration options:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
string, one of |
Yes |
|
No |
||
No |
||
No |
||
No |
||
No |
Details
edit
add_field
edit- 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 { fingerprint { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } }
# You can also add multiple fields at once: filter { fingerprint { 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.
add_tag
edit- 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 { fingerprint { add_tag => [ "foo_%{somefield}" ] } }
# You can also add multiple tags at once: filter { fingerprint { 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).
base64encode
edit- Value type is boolean
-
Default value is
false
When set to true, SHA1', SHA256, SHA384, SHA512 and MD5 fingerprint methods will be returned base64 encoded rather than hex encoded.
concatenate_sources
edit- Value type is boolean
-
Default value is
false
When set to true
, we concatenate the values of all fields into 1 string like the old checksum filter.
enable_metric
edit- Value type is boolean
-
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.
id
edit- Value type is string
- There is no default value for this setting.
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 useful
when you have two or more plugins of the same type, for example, if you have 2 grok filters.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { stdout { id => "my_plugin_id" } }
key
edit- Value type is string
- There is no default value for this setting.
When used with IPV4_NETWORK
method fill in the subnet prefix length
Not required for MURMUR3
or UUID
methods
With other methods fill in the HMAC
key
method
edit- This is a required setting.
-
Value can be any of:
SHA1
,SHA256
,SHA384
,SHA512
,MD5
,MURMUR3
,IPV4_NETWORK
,UUID
,PUNCTUATION
-
Default value is
"SHA1"
Fingerprint method
periodic_flush
edit- Value type is boolean
-
Default value is
false
Call the filter flush method at regular interval. Optional.
remove_field
edit- Value type is array
-
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 { fingerprint { remove_field => [ "foo_%{somefield}" ] } }
# You can also remove multiple fields at once: filter { fingerprint { 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.
remove_tag
edit- 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 { fingerprint { remove_tag => [ "foo_%{somefield}" ] } }
# You can also remove multiple tags at once: filter { fingerprint { 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.