Aggregate filter plugin

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 per pipeline (as aggregate maps are shared at pipeline level).

Example:

    filter {
      aggregate {
        aggregate_maps_path => "/path/to/.aggregate_maps"
      }
    }

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

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

Available variables are :

event: current Logstash event

map: aggregated map associated to task_id, containing key/value pairs. Data structure is a ruby Hash

map_meta: meta informations associated to aggregate map. It allows to set a custom timeout or inactivity_timeout. It allows also to get creation_timestamp, lastevent_timestamp and task_id.

When option push_map_as_event_on_timeout=true, if you set map_meta.timeout=0 in code block, then aggregated map is immediately pushed as a new event.

Example:

    filter {
      aggregate {
        code => "map['sql_duration'] += event.get('duration')"
      }
    }

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

The amount of seconds (since the last event) after which a task is considered as expired.

When timeout occurs for a task, its aggregate map is evicted.

If push_map_as_event_on_timeout or push_previous_map_as_event is set to true, the task aggregation map is pushed as a new Logstash event.

inactivity_timeout can be defined for each "task_id" pattern.

inactivity_timeout must be lower than timeout.

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

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.

The expression defining task ID to correlate logs.

This value must uniquely identify the task.

Example:

    filter {
      aggregate {
        task_id => "%{type}%{my_task_id}"
      }
    }

The amount of seconds (since the first event) after which a task is considered as expired.

When timeout occurs for a task, its aggregate map is evicted.

If push_map_as_event_on_timeout or push_previous_map_as_event is set to true, the task aggregation map is pushed as a new Logstash event.

Timeout can be defined for each "task_id" pattern.

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:

    filter {
      aggregate {
        timeout_code => "event.set('state', 'timeout')"
      }
    }

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

Example:

    filter {
      aggregate {
        timeout_tags => ["aggregate_timeout"]
      }
    }

This option indicates the timeout generated event’s field where the current "task_id" value will be set. This can help to correlate which tasks have been timed out.

By default, if this option is not set, task id value won’t be set into timeout generated event.

Example:

    filter {
      aggregate {
        timeout_task_id_field => "task_id"
      }
    }

By default, timeout is computed using system time, where Logstash is running.

When this option is set, timeout is computed using event timestamp field indicated in this option. It means that when a first event arrives on aggregate filter and induces a map creation, map creation time will be equal to this event timestamp. Then, each time a new event arrives on aggregate filter, event timestamp is compared to map creation time to check if timeout happened.

This option is particularly useful when processing old logs with option push_map_as_event_on_timeout => true. It lets to generate aggregated events based on timeout on old logs, where system time is inappropriate.

Warning : so that this option works fine, it must be set on first aggregate filter.

Example:

    filter {
      aggregate {
        timeout_timestamp_field => "@timestamp"
      }
    }

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}" }
      }
    }

    # 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}" ]
      }
    }

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

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.

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

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

Call the filter flush method at regular interval. Optional.

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}" ]
      }
    }

    # 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}" ]
      }
    }

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