fingerprintedit

Fingerprint fields using by replacing values with a consistent hash.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

fingerprint {
    method => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

add_tag

array

No

[]

base64encode

boolean

No

false

concatenate_sources

boolean

No

false

key

string

No

method

string, one of ["SHA1", "SHA256", "SHA384", "SHA512", "MD5", "MURMUR3", "IPV4_NETWORK", "UUID", "PUNCTUATION"]

Yes

"SHA1"

periodic_flush

boolean

No

false

remove_field

array

No

[]

remove_tag

array

No

[]

source

array

No

"message"

target

string

No

"fingerprint"

Detailsedit

 

add_fieldedit

  • 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_tagedit

  • 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).

base64encodeedit

  • 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_sourcesedit

  • 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.

keyedit

  • 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

methodedit

  • 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_flushedit

  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

remove_fieldedit

  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary fields from this event. 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_tagedit

  • 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.

sourceedit

  • Value type is array
  • Default value is "message"

Source field(s)

targetedit

  • Value type is string
  • Default value is "fingerprint"

Target field. will overwrite current value of a field if it exists.