Mutate filter plugin v3.3.3

  • Plugin version: v3.3.3
  • Released on: 2018-08-15
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Help

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.

Description

The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events.

Mutate Filter Configuration Options

This plugin supports the following configuration options plus the Common Options described later.

Also see Common Options for a list of options supported by all filter plugins.

 

convert

  • Value type is hash
  • There is no default value for this setting.

Convert a field’s value to a different type, like turning a string to an integer. If the field value is an array, all members will be converted. If the field is a hash no action will be taken.

Valid conversion targets, and their expected behaviour with different inputs are:

  • integer:

    • strings are parsed; comma-separators are supported (e.g., the string "1,000" produces an integer with value of one thousand); when strings have decimal parts, they are truncated.
    • floats and decimals are truncated (e.g., 3.99 becomes 3, -2.7 becomes -2)
    • boolean true and boolean false are converted to 1 and 0 respectively
  • integer_eu:

    • same as integer, except string values support dot-separators and comma-decimals (e.g., "1.000" produces an integer with value of one thousand)
  • float:

    • integers are converted to floats
    • strings are parsed; comma-separators and dot-decimals are supported (e.g., "1,000.5" produces an integer with value of one thousand and one half)
    • boolean true and boolean false are converted to 1.0 and 0.0 respectively
  • float_eu:

    • same as float, except string values support dot-separators and comma-decimals (e.g., "1.000,5" produces an integer with value of one thousand and one half)
  • string:

    • all values are stringified and encoded with UTF-8
  • boolean:

    • strings "true", "t", "yes", "y", and "1" are converted to boolean true
    • strings "false", "f", "no", "n", and "0" are converted to boolean false
    • empty strings are converted to boolean false
    • all other values pass straight through without conversion and log a warning message

This plugin can convert multiple fields in the same document, see the example below.

Example:

filter {
  mutate {
    convert => {
      "fieldname" => "integer"
      "booleanfield" => "boolean"
    }
  }
}

copy

  • Value type is hash
  • There is no default value for this setting.

Copy an existing field to another field. Existing target field will be overriden.

Example:

filter {
  mutate {
     copy => { "source_field" => "dest_field" }
  }
}

gsub

  • Value type is array
  • There is no default value for this setting.

Match a regular expression against a field value and replace all matches with a replacement string. Only fields that are strings or arrays of strings are supported. For other kinds of fields no action will be taken.

This configuration takes an array consisting of 3 elements per field/substitution.

Be aware of escaping any backslash in the config file.

Example:

filter {
  mutate {
    gsub => [
      # replace all forward slashes with underscore
      "fieldname", "/", "_",
      # replace backslashes, question marks, hashes, and minuses
      # with a dot "."
      "fieldname2", "[\\?#-]", "."
    ]
  }
}

join

  • Value type is hash
  • There is no default value for this setting.

Join an array with a separator character. Does nothing on non-array fields.

Example:

filter {
  mutate {
    join => { "fieldname" => "," }
  }
}

lowercase

  • Value type is array
  • There is no default value for this setting.

Convert a string to its lowercase equivalent.

Example:

filter {
  mutate {
    lowercase => [ "fieldname" ]
  }
}

merge

  • Value type is hash
  • There is no default value for this setting.

Merge two fields of arrays or hashes. String fields will be automatically be converted into an array, so:

`array` + `string` will work
`string` + `string` will result in an 2 entry array in `dest_field`
`array` and `hash` will not work

Example:

filter {
  mutate {
     merge => { "dest_field" => "added_field" }
  }
}

coerce

  • Value type is hash
  • There is no default value for this setting.

Set the default value of a field that exists but is null

Example:

filter {
  mutate {
    # Sets the default value of the 'field1' field to 'default_value'
    coerce => { "field1" => "default_value" }
  }
}

rename

  • Value type is hash
  • There is no default value for this setting.

Rename one or more fields.

Example:

filter {
  mutate {
    # Renames the 'HOSTORIP' field to 'client_ip'
    rename => { "HOSTORIP" => "client_ip" }
  }
}

replace

  • Value type is hash
  • There is no default value for this setting.

Replace the value of a field with a new value. The new value can include %{foo} strings to help you build a new value from other parts of the event.

Example:

filter {
  mutate {
    replace => { "message" => "%{source_host}: My new message" }
  }
}

split

  • Value type is hash
  • There is no default value for this setting.

Split a field to an array using a separator character. Only works on string fields.

Example:

filter {
  mutate {
     split => { "fieldname" => "," }
  }
}

strip

  • Value type is array
  • There is no default value for this setting.

Strip whitespace from field. NOTE: this only works on leading and trailing whitespace.

Example:

filter {
  mutate {
     strip => ["field1", "field2"]
  }
}

update

  • Value type is hash
  • There is no default value for this setting.

Update an existing field with a new value. If the field does not exist, then no action will be taken.

Example:

filter {
  mutate {
    update => { "sample" => "My new message" }
  }
}

uppercase

  • Value type is array
  • There is no default value for this setting.

Convert a string to its uppercase equivalent.

Example:

filter {
  mutate {
    uppercase => [ "fieldname" ]
  }
}

capitalize

  • Value type is array
  • There is no default value for this setting.

Convert a string to its capitalized equivalent.

Example:

filter {
  mutate {
    capitalize => [ "fieldname" ]
  }
}

Common Options

The following configuration options are supported by all filter plugins:

add_field

  • 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 {
  mutate {
    add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
  }
}
# You can also add multiple fields at once:
filter {
  mutate {
    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

  • 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 {
  mutate {
    add_tag => [ "foo_%{somefield}" ]
  }
}
# You can also add multiple tags at once:
filter {
  mutate {
    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).

enable_metric

  • 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

  • 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 mutate filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

filter {
  mutate {
    id => "ABC"
  }
}

periodic_flush

  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

remove_field

  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary fields from this event. Example:

filter {
  mutate {
    remove_field => [ "foo_%{somefield}" ]
  }
}
# You can also remove multiple fields at once:
filter {
  mutate {
    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

  • 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 {
  mutate {
    remove_tag => [ "foo_%{somefield}" ]
  }
}
# You can also remove multiple tags at once:
filter {
  mutate {
    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. :plugin: mutate :type: filter