Elasticsearch

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 {
  throttle {
    add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
  }
}

# You can also add multiple fields at once:
filter {
  throttle {
    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.

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 {
  throttle {
    add_tag => [ "foo_%{somefield}" ]
  }
}

# You can also add multiple tags at once:
filter {
  throttle {
    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).

Events greater than this count will be throttled. Setting this value to -1, the default, will cause no messages to be throttled based on the upper bound.

Events less than this count will be throttled. Setting this value to -1, the default, will cause no messages to be throttled based on the lower bound.

Only handle events without all/any (controlled by exclude_any config option) of these tags. Optional.

The name to use in configuration files. New plugins should start life at milestone 1. The key used to identify events. Events with the same key will be throttled as a group. Field substitutions are allowed, so you can combine multiple fields.

The maximum number of counters to store before the oldest counter is purged. Setting this value to -1 will prevent an upper bound no constraint on the number of counters and they will only be purged after expiration. This configuration value should only be used as a memory control mechanism and can cause early counter expiration if the value is reached. It is recommended to leave the default value and ensure that your key is selected such that it limits the number of counters required (i.e. don’t use UUID as the key!)

The period in seconds after the first occurrence of an event until the count is reset for the event. This period is tracked per unique key value. Field substitutions are allowed in this value. They will be evaluated when the first event for a given key is seen. This allows you to specify that certain kinds of events throttle for a specific period.

Call the filter flush method at regular interval. Optional.

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

filter {
  throttle {
    remove_field => [ "foo_%{somefield}" ]
  }
}

# You can also remove multiple fields at once:
filter {
  throttle {
    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.

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 {
  throttle {
    remove_tag => [ "foo_%{somefield}" ]
  }
}

# You can also remove multiple tags at once:
filter {
  throttle {
    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.

Only handle events with all/any (controlled by include_any config option) of these tags. Optional.

Note that all of the specified routing options (type,tags,exclude_tags,include_fields, exclude_fields) must be met in order for the event to be handled by the filter. The type to act on. If a type is given, then this filter will only act on messages with the same type. See any input plugin’s "type" attribute for more. Optional.