aggregate

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

The path to file where aggregate maps are stored when logstash stops and are loaded from when logstash starts.

If not defined, aggregate maps will not be stored at logstash stop and will be lost. Must be defined in only one aggregate filter (as aggregate maps are global).

Example value : "/path/to/.aggregate_maps"

The code to execute to update map, using current event.

Or on the contrary, the code to execute to update event, using current map.

You will have a map variable and an event variable available (that is the event itself).

Example value : "map['sql_duration'] += event.get('duration')"

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.

Tell the filter that task is ended, and therefore, to delete aggregate map after code execution.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

Tell the filter what to do with aggregate map.

create: create the map, and execute the code only if map wasn’t created before

update: doesn’t create the map, and execute the code only if map was created before

create_or_update: create the map if it wasn’t created before, execute the code in all cases

Call the filter flush method at regular interval. Optional.

When this option is enabled, each time a task timeout is detected, it pushes task aggregation map as a new logstash event. This enables to detect and process task timeouts in logstash, but also to manage tasks that have no explicit end event.

When this option is enabled, each time aggregate plugin detects a new task id, it pushes previous aggregate map as a new logstash event, and then creates a new empty map for the next task.

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

The expression defining task ID to correlate logs.

This value must uniquely identify the task in the system.

Example value : "%{application}%{my_task_id}"

The amount of seconds after a task "end event" can be considered lost.

When timeout occurs for a task, The task "map" is evicted.

Timeout can be defined for each "task_id" pattern.

If no timeout is defined, default timeout will be applied : 1800 seconds.

The code to execute to complete timeout generated event, when push_map_as_event_on_timeout or push_previous_map_as_event is set to true. The code block will have access to the newly generated timeout event that is pre-populated with the aggregation map.

If timeout_task_id_field is set, the event is also populated with the task_id value

Example value: "event.set('state', 'timeout')"

Defines tags to add when a timeout event is generated and yield

This option indicates the timeout generated event’s field for the "task_id" value. The task id will then be set into the timeout event. This can help correlate which tasks have been timed out.

This field has no default value and will not be set on the event if not configured.

Example:

If the task_id is "12345" and this field is set to "my_id", the generated timeout event will contain 'my_id' key with '12345' value.