translate

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-filter-translate.

A general search and replace tool which uses a configured hash and/or a YAML file to determine replacement values.

The dictionary entries can be specified in one of two ways: First, the dictionary configuration item may contain a hash representing the mapping. Second, an external YAML file (readable by logstash) may be specified in the dictionary_path configuration item. These two methods may not be used in conjunction; it will produce an error.

Operationally, if the event field specified in the field configuration matches the EXACT contents of a dictionary entry key (or matches a regex if regex configuration item has been enabled), the field’s value will be substituted with the matched key’s value from the dictionary.

By default, the translate filter will replace the contents of the maching event field (in-place). However, by using the destination configuration item, you may also specify a target event field to populate with the new translated value.

Alternatively, for simple string search and replacements for just a few values you might consider using the gsub function of the mutate filter.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

translate {
    field => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

add_tag

array

No

[]

destination

string

No

"translation"

dictionary

hash

No

{}

dictionary_path

a valid filesystem path

No

exact

boolean

No

true

fallback

string

No

field

string

Yes

override

boolean

No

false

periodic_flush

boolean

No

false

refresh_interval

number

No

300

regex

boolean

No

false

remove_field

array

No

[]

remove_tag

array

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 {
      translate {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }
[source,ruby]
    # You can also add multiple fields at once:
    filter {
      translate {
        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 {
      translate {
        add_tag => [ "foo_%{somefield}" ]
      }
    }
[source,ruby]
    # You can also add multiple tags at once:
    filter {
      translate {
        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).

destination

edit
  • Value type is string
  • Default value is "translation"

The destination field you wish to populate with the translated code. The default is a field named translation. Set this to the same value as source if you want to do a substitution, in this case filter will allways succeed. This will clobber the old value of the source field!

dictionary

edit
  • Value type is hash
  • Default value is {}

The dictionary to use for translation, when specified in the logstash filter configuration item (i.e. do not use the @dictionary_path YAML file) Example:

    filter {
      translate {
        dictionary => [ "100", "Continue",
                        "101", "Switching Protocols",
                        "merci", "thank you",
                        "old version", "new version" ]
      }
    }
NOTE: it is an error to specify both `dictionary` and `dictionary_path`

dictionary_path

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

The full path of the external YAML dictionary file. The format of the table should be a standard YAML file. Make sure you specify any integer-based keys in quotes. The YAML file should look something like this:

    "100": Continue
    "101": Switching Protocols
    merci: gracias
    old version: new version

it is an error to specify both dictionary and dictionary_path

exact

edit
  • Value type is boolean
  • Default value is true

When exact => true, the translate filter will populate the destination field with the exact contents of the dictionary value. When exact => false, the filter will populate the destination field with the result of any existing destination field’s data, with the translated value substituted in-place.

For example, consider this simple translation.yml, configured to check the data field:

    foo: bar

If logstash receives an event with the data field set to foo, and exact => true, the destination field will be populated with the string bar. If exact => false, and logstash receives the same event, the destination field will be also set to bar. However, if logstash receives an event with the data field set to foofing, the destination field will be set to barfing.

Set both exact => true AND regex => `true if you would like to match using dictionary keys as regular expressions. A large dictionary could be expensive to match in this case.

fallback

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

In case no translation occurs in the event (no matches), this will add a default translation string, which will always populate field, if the match failed.

For example, if we have configured fallback => "no match", using this dictionary:

    foo: bar

Then, if logstash received an event with the field foo set to bar, the destination field would be set to bar. However, if logstash received an event with foo set to nope, then the destination field would still be populated, but with the value of no match. This configuration can be dynamic and include parts of the event using the %{field} syntax.

field

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The name of the logstash event field containing the value to be compared for a match by the translate filter (e.g. message, host, response_code).

If this field is an array, only the first value will be used.

override

edit
  • Value type is boolean
  • Default value is false

If the destination (or target) field already exists, this configuration item specifies whether the filter should skip translation (default) or overwrite the target field value with the new translation value.

periodic_flush

edit
  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

refresh_interval

edit
  • Value type is number
  • Default value is 300

When using a dictionary file, this setting will indicate how frequently (in seconds) logstash will check the YAML file for updates.

regex

edit
  • Value type is boolean
  • Default value is false

If you’d like to treat dictionary keys as regular expressions, set exact => true. Note: this is activated only when exact => true.

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 {
      translate {
        remove_field => [ "foo_%{somefield}" ]
      }
    }
[source,ruby]
    # You can also remove multiple fields at once:
    filter {
      translate {
        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 {
      translate {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }
[source,ruby]
    # You can also remove multiple tags at once:
    filter {
      translate {
        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.