logstash-filter-aggregate 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b057d7aa6713960e001b6aefd58e80790bdf5a0
-  data.tar.gz: 907229127b32da2754a62578af6adaa4468ab40a
+  metadata.gz: a472e0a2745d183d8fac17465d5323f6c90e403a
+  data.tar.gz: 0ab61d24cfc2ddbe5abc757e49f7de6bf993f7cf
 SHA512:
-  metadata.gz: 8e77c72b1f8c14fe69224c151841dd175a67615e921b0653412ee10c8b0378e3a0f06d69360527e586fb0374e3f27b408982dd31db6e051f972b4a6db7fcddeb
-  data.tar.gz: c7d65a60dbc9c07765e27b7fa08b103fdbdd210eacf4c12ec9936188bcee3952ec38207608d88b4269ab8ff13984dd179fa0c15d7a220783230e92e2155437be
+  metadata.gz: 3c44c668f3f6e896fe0cd2f453bb40c8ea478e77e606f8d553282a70d65f0aca14863a14907f73ee1638e84383c939ce276c74d892757eb20cea74d96a20484c
+  data.tar.gz: 276033d1b5227a625b3092fed02097d64c6cd3c0e7eaa2ce176565d3cc6264eea4a7a2ce32fc1c037e69a5e538f362ba62f94f09681cbfe4174d0726670261c7

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.6.0
+- new feature: 'inactivity_timeout'. Events for a given `task_id` will be aggregated for as long as they keep arriving within the defined `inactivity_timeout` option - the inactivity timeout is reset each time a new event happens. On the contrary, `timeout` is never reset and happens after `timeout` seconds since aggregation map creation.
+
 ## 2.5.2
 - bugfix: fix 'aggregate_maps_path' load (issue #62). Re-start of Logstash died when no data were provided in 'aggregate_maps_path' file for some aggregate task_id patterns
 - enhancement: at Logstash startup, check that 'task_id' option contains a field reference expression (else raise error)

data/CONTRIBUTORS

@@ -7,6 +7,7 @@ Maintainers:
 Contributors:
 * Fabien Baligand (fbaligand)
 * Artur Kronenberg (pandaadb)
+* Fernando Galandrini (fjgal)
 
 Note: If you've sent us patches, bug reports, or otherwise contributed to
 Logstash, and you aren't on the list above and want to be, please let us know

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
+
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/README.md

@@ -1,327 +1,104 @@
-# Logstash Filter Aggregate Documentation
+# Aggregate Logstash Plugin
 
 [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-aggregate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-aggregate)
 
-The aim of this filter is to aggregate information available among several events (typically log lines) belonging to a same task, and finally push aggregated information into final task event.
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
-You should be very careful to set Logstash filter workers to 1 (`-w 1` flag) for this filter to work correctly 
-otherwise events may be processed out of sequence and unexpected results will occur.
- 
-## Example #1
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
-* with these given logs : 
-```
-     INFO - 12345 - TASK_START - start
-     INFO - 12345 - SQL - sqlQuery1 - 12
-     INFO - 12345 - SQL - sqlQuery2 - 34
-     INFO - 12345 - TASK_END - end
-```
+## Documentation
 
-* you can aggregate "sql duration" for the whole task with this configuration : 
-``` ruby
-     filter {
-         grok {
-             match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
-         }
-     
-         if [logger] == "TASK_START" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "map['sql_duration'] = 0"
-                 map_action => "create"
-             }
-         }
-     
-         if [logger] == "SQL" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "map['sql_duration'] += event.get('duration')"
-                 map_action => "update"
-             }
-         }
-     
-         if [logger] == "TASK_END" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "event.set('sql_duration', map['sql_duration'])"
-                 map_action => "update"
-                 end_of_task => true
-                 timeout => 120
-             }
-         }
-     }
-```
+Latest aggregate plugin documentation is available [here](docs/index.asciidoc).
 
-* the final event then looks like :
-``` ruby
-{
-         "message" => "INFO - 12345 - TASK_END - end",
-    "sql_duration" => 46
-}
-```
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
-the field `sql_duration` is added and contains the sum of all sql queries durations.
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
-## Example #2 : no start event
-
-* If you have the same logs than example #1, but without a start log : 
-```
-     INFO - 12345 - SQL - sqlQuery1 - 12
-     INFO - 12345 - SQL - sqlQuery2 - 34
-     INFO - 12345 - TASK_END - end
-```
+## Changelog
 
-* you can also aggregate "sql duration" with a slightly different configuration : 
-``` ruby
-     filter {
-         grok {
-             match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
-         }
-     
-         if [logger] == "SQL" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "map['sql_duration'] ||= 0 ; map['sql_duration'] += event.get('duration')"
-             }
-         }
-     
-         if [logger] == "TASK_END" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "event.set('sql_duration', map['sql_duration'])"
-                 end_of_task => true
-                 timeout => 120
-             }
-         }
-     }
-```
+Read [CHANGELOG.md](CHANGELOG.md).
 
-* the final event is exactly the same than example #1
-* the key point is the "||=" ruby operator.  
-it allows to initialize 'sql_duration' map entry to 0 only if this map entry is not already initialized
+## Need Help?
 
-## Example #3 : no end event
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
-Third use case: You have no specific end event. 
+## Developing
 
-A typical case is aggregating or tracking user behaviour. We can track a user by its ID through the events, however once the user stops interacting, the events stop coming in. There is no specific event indicating the end of the user's interaction.
+### 1. Plugin Developement and Testing
 
-In this case, we can enable the option 'push_map_as_event_on_timeout' to enable pushing the aggregation map as a new event when a timeout occurs.  
-In addition, we can enable 'timeout_code' to execute code on the populated timeout event.
-We can also add 'timeout_task_id_field' so we can correlate the task_id, which in this case would be the user's ID. 
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
 
-* Given these logs:
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
 
+- Install dependencies
+```sh
+bundle install
 ```
-    INFO - 12345 - Clicked One
-    INFO - 12345 - Clicked Two
-    INFO - 12345 - Clicked Three
-```
 
-* You can aggregate the amount of clicks the user did like this:
-
-``` ruby
-    filter {
-        grok {
-                 match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:user_id} - %{GREEDYDATA:msg_text}" ]
-        }
-
-        aggregate {
-            task_id => "%{user_id}"
-            code => "map['clicks'] ||= 0; map['clicks'] += 1;"
-            push_map_as_event_on_timeout => true
-            timeout_task_id_field => "user_id"
-            timeout => 600 # 10 minutes timeout
-            timeout_tags => ['_aggregatetimeout']
-            timeout_code => "event.set('several_clicks', event.get('clicks') > 1)"
-        }
-    }
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
 ```
 
-* After ten minutes, this will yield an event like:
-
-``` json
-    {
-        "user_id": "12345",
-        "clicks": 3,
-        "several_clicks": true,
-        "tags": [
-            "_aggregatetimeout"
-        ]
-    }
+- Run tests
+
+```sh
+bundle exec rspec
 ```
 
+### 2. Running your unpublished Plugin in Logstash
 
-## Example #4 : no end event and tasks come one after the other
+#### 2.1 Run in a local Logstash clone
 
-Fourth use case : like example #3, you have no specific end event, but also, tasks come one after the other.  
-That is to say : tasks are not interlaced. All task1 events come, then all task2 events come, ...  
-In that case, you don't want to wait task timeout to flush aggregation map.  
-* A typical case is aggregating results from jdbc input plugin.
-* Given that you have this SQL query : `SELECT country_name, town_name FROM town ORDER BY country_name`  
-* Using jdbc input plugin, you get these 3 events from :
-``` json
-  { "country_name": "France", "town_name": "Paris" }
-  { "country_name": "France", "town_name": "Marseille" }
-  { "country_name": "USA", "town_name": "New-York" }
-```
-* And you would like these 2 result events to push them into elasticsearch :
-``` json
-  { "country_name": "France", "towns": [ {"town_name": "Paris"}, {"town_name": "Marseille"} ] }
-  { "country_name": "USA", "towns": [ {"town_name": "New-York"} ] }
-```
-* You can do that using `push_previous_map_as_event` aggregate plugin option :
-``` ruby
-    filter {
-      aggregate {
-        task_id => "%{country_name}"
-        code => "
-          map['country_name'] = event.get('country_name')
-          map['towns'] ||= []
-          map['towns'] << {'town_name' => event.get('town_name')}
-          event.cancel()
-        "
-        push_previous_map_as_event => true
-        timeout => 3
-      }
-    }
-```
-* The key point is that each time aggregate plugin detects a new `country_name`, it pushes previous aggregate map as a new Logstash event, and then creates a new empty map for the next country
-* When 5s timeout comes, the last aggregate map is pushed as a new event
-* Finally, initial events (which are not aggregated) are dropped because useless (thanks to `event.cancel()`)
-
-## How it works
-- the filter needs a "task_id" to correlate events (log lines) of a same task
-- at the task beggining, filter creates a map, attached to task_id
-- for each event, you can execute code using 'event' and 'map' (for instance, copy an event field to map)
-- in the final event, you can execute a last code (for instance, add map data to final event)
-- after the final event, the map attached to task is deleted (thanks to `end_of_task => true`)
-- an aggregate map is tied to one task_id value which is tied to one task_id pattern.  
-So if you have 2 filters with different task_id patterns, even if you have same task_id value, they won't share the same aggregate map.
-- in one filter configuration, it is recommanded to define a timeout option to protect the filter against unterminated tasks. It tells the filter to delete expired maps
-- if no timeout is defined, by default, all maps older than 1800 seconds are automatically deleted
-- all timeout options have to be defined in only one aggregate filter per task_id pattern.  
-Timeout options are : `timeout, timeout_code, push_map_as_event_on_timeout, push_previous_map_as_event, timeout_task_id_field, timeout_tags`
-- if `code` execution raises an exception, the error is logged and event is tagged '_aggregateexception'
-
-## Use Cases
-- extract some cool metrics from task logs and push them into task final log event (like in example #1 and #2)
-- extract error information in any task log line, and push it in final task event (to get a final event with all error information if any)
-- extract all back-end calls as a list, and push this list in final task event (to get a task profile)
-- extract all http headers logged in several lines to push this list in final task event (complete http request info)
-- for every back-end call, collect call details available on several lines, analyse it and finally tag final back-end call log line (error, timeout, business-warning, ...)
-- Finally, task id can be any correlation id matching your need : it can be a session id, a file path, ...
-
-## Aggregate Plugin Options
-- **task_id :**  
-The expression defining task ID to correlate logs.  
-This value must uniquely identify the task.  
-This option is required.  
-Example:
-``` ruby
-filter {
-  aggregate {
-    task_id => "%{type}%{my_task_id}"
-  }
-}
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
+- Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
 
-- **code:**  
-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).  
-This option is required.  
-Example:
-``` ruby
-filter {
-  aggregate {
-    code => "map['sql_duration'] += event.get('duration')"
-  }
-}
-```
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
 
-- **map_action:**  
-Tell the filter what to do with aggregate map (default :  "create_or_update").  
-`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  
-Default value: `create_or_update`  
-
-- **end_of_task:**  
-Tell the filter that task is ended, and therefore, to delete aggregate map after code execution.  
-Default value: `false`  
-
-- **aggregate_maps_path:**  
-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:
-``` ruby
-filter {
-  aggregate {
-    aggregate_maps_path => "/path/to/.aggregate_maps"
-  }
-}
 ```
-
-- **timeout:**  
-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.  
-
-- **timeout_code**  
-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:
-``` ruby
-filter {
-  aggregate {
-    timeout_code => "event.set('state', 'timeout')"
-  }
-}
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
 ```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
 
-- **push_map_as_event_on_timeout**  
-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.  
-Default value: `false`  
-
-- **push_previous_map_as_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.  
-_WARNING:_ this option works fine only if tasks come one after the other. It means : all task1 events, then all task2 events, etc...  
-Default value: `false`  
-
-- **timeout_task_id_field**  
-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.  
-For example, with option `timeout_task_id_field => "my_id"` ,when timeout task id is `"12345"`, the generated timeout event will contain `'my_id' => '12345'`.  
-By default, if this option is not set, task id value won't be set into timeout generated event.  
-
-- **timeout_tags**  
-Defines tags to add when a timeout event is generated and yield.  
-Default value: `[]`  
-Example:
-``` ruby
-filter {
-  aggregate {
-    timeout_tags => ["aggregate_timeout']
-  }
-}
-```
+#### 2.2 Run in an installed Logstash
 
-## Changelog
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
 
-Read [CHANGELOG.md](CHANGELOG.md).
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
 
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
 
-## Need Help?
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
 
-Need help? Try #Logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
 
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
 
-## Want to contribute?
+It is more important to the community that you are able to contribute.
 
-Read [BUILD.md](BUILD.md).
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/docs/index.asciidoc

@@ -0,0 +1,552 @@
+:plugin: aggregate
+:type: filter
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Aggregate
+
+include::{include_path}/plugin_header.asciidoc[]
+
+
+<<plugins-{type}s-{plugin}-description>> +
+<<plugins-{type}s-{plugin}-example1>> +
+<<plugins-{type}s-{plugin}-example2>> +
+<<plugins-{type}s-{plugin}-example3>> +
+<<plugins-{type}s-{plugin}-example4>> +
+<<plugins-{type}s-{plugin}-example5>> +
+<<plugins-{type}s-{plugin}-howitworks>> +
+<<plugins-{type}s-{plugin}-usecases>> +
+<<plugins-{type}s-{plugin}-options>> +
+
+
+[id="plugins-{type}s-{plugin}-description"]
+==== Description
+
+
+The aim of this filter is to aggregate information available among several events (typically log lines) belonging to a same task,
+and finally push aggregated information into final task event.
+
+You should be very careful to set Logstash filter workers to 1 (`-w 1` flag) for this filter to work correctly
+otherwise events may be processed out of sequence and unexpected results will occur.
+
+
+[id="plugins-{type}s-{plugin}-example1"]
+==== Example #1
+
+* with these given logs :
+
+[source,ruby]
+----------------------------------
+ INFO - 12345 - TASK_START - start
+ INFO - 12345 - SQL - sqlQuery1 - 12
+ INFO - 12345 - SQL - sqlQuery2 - 34
+ INFO - 12345 - TASK_END - end
+----------------------------------
+
+* you can aggregate "sql duration" for the whole task with this configuration :
+
+[source,ruby]
+----------------------------------
+ filter {
+   grok {
+     match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
+   }
+
+   if [logger] == "TASK_START" {
+     aggregate {
+       task_id => "%{taskid}"
+       code => "map['sql_duration'] = 0"
+       map_action => "create"
+     }
+   }
+
+   if [logger] == "SQL" {
+     aggregate {
+       task_id => "%{taskid}"
+       code => "map['sql_duration'] += event.get('duration')"
+       map_action => "update"
+     }
+   }
+
+   if [logger] == "TASK_END" {
+     aggregate {
+       task_id => "%{taskid}"
+       code => "event.set('sql_duration', map['sql_duration'])"
+       map_action => "update"
+       end_of_task => true
+       timeout => 120
+     }
+   }
+ }
+----------------------------------
+
+* the final event then looks like :
+
+[source,ruby]
+----------------------------------
+{
+  "message" => "INFO - 12345 - TASK_END - end message",
+  "sql_duration" => 46
+}
+----------------------------------
+
+the field `sql_duration` is added and contains the sum of all sql queries durations.
+
+
+[id="plugins-{type}s-{plugin}-example2"]
+==== Example #2 : no start event
+
+* If you have the same logs than example #1, but without a start log :
+
+[source,ruby]
+----------------------------------
+ INFO - 12345 - SQL - sqlQuery1 - 12
+ INFO - 12345 - SQL - sqlQuery2 - 34
+ INFO - 12345 - TASK_END - end
+----------------------------------
+
+* you can also aggregate "sql duration" with a slightly different configuration :
+
+[source,ruby]
+----------------------------------
+ filter {
+   grok {
+     match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
+   }
+
+   if [logger] == "SQL" {
+     aggregate {
+       task_id => "%{taskid}"
+       code => "map['sql_duration'] ||= 0 ; map['sql_duration'] += event.get('duration')"
+     }
+   }
+
+   if [logger] == "TASK_END" {
+     aggregate {
+       task_id => "%{taskid}"
+       code => "event.set('sql_duration', map['sql_duration'])"
+       end_of_task => true
+       timeout => 120
+     }
+   }
+ }
+----------------------------------
+
+* the final event is exactly the same than example #1
+* the key point is the "||=" ruby operator. It allows to initialize 'sql_duration' map entry to 0 only if this map entry is not already initialized
+
+
+[id="plugins-{type}s-{plugin}-example3"]
+==== Example #3 : no end event
+
+Third use case: You have no specific end event.
+
+A typical case is aggregating or tracking user behaviour. We can track a user by its ID through the events, however once the user stops interacting, the events stop coming in. There is no specific event indicating the end of the user's interaction.
+
+In this case, we can enable the option 'push_map_as_event_on_timeout' to enable pushing the aggregation map as a new event when a timeout occurs.
+In addition, we can enable 'timeout_code' to execute code on the populated timeout event.
+We can also add 'timeout_task_id_field' so we can correlate the task_id, which in this case would be the user's ID.
+
+* Given these logs:
+
+[source,ruby]
+----------------------------------
+INFO - 12345 - Clicked One
+INFO - 12345 - Clicked Two
+INFO - 12345 - Clicked Three
+----------------------------------
+
+* You can aggregate the amount of clicks the user did like this:
+
+[source,ruby]
+----------------------------------
+filter {
+  grok {
+    match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:user_id} - %{GREEDYDATA:msg_text}" ]
+  }
+
+  aggregate {
+    task_id => "%{user_id}"
+    code => "map['clicks'] ||= 0; map['clicks'] += 1;"
+    push_map_as_event_on_timeout => true
+    timeout_task_id_field => "user_id"
+    timeout => 600 # 10 minutes timeout
+    timeout_tags => ['_aggregatetimeout']
+    timeout_code => "event.set('several_clicks', event.get('clicks') > 1)"
+  }
+}
+----------------------------------
+
+* After ten minutes, this will yield an event like:
+
+[source,json]
+----------------------------------
+{
+  "user_id": "12345",
+  "clicks": 3,
+  "several_clicks": true,
+    "tags": [
+       "_aggregatetimeout"
+    ]
+}
+----------------------------------
+
+
+[id="plugins-{type}s-{plugin}-example4"]
+==== Example #4 : no end event and tasks come one after the other
+
+Fourth use case : like example #3, you have no specific end event, but also, tasks come one after the other. +
+That is to say : tasks are not interlaced. All task1 events come, then all task2 events come, ... +
+In that case, you don't want to wait task timeout to flush aggregation map. +
+
+* A typical case is aggregating results from jdbc input plugin.
+* Given that you have this SQL query : `SELECT country_name, town_name FROM town`
+* Using jdbc input plugin, you get these 3 events from :
+
+[source,json]
+----------------------------------
+  { "country_name": "France", "town_name": "Paris" }
+  { "country_name": "France", "town_name": "Marseille" }
+  { "country_name": "USA", "town_name": "New-York" }
+----------------------------------
+
+* And you would like these 2 result events to push them into elasticsearch :
+
+[source,json]
+----------------------------------
+  { "country_name": "France", "towns": [ {"town_name": "Paris"}, {"town_name": "Marseille"} ] }
+  { "country_name": "USA", "towns": [ {"town_name": "New-York"} ] }
+----------------------------------
+
+* You can do that using `push_previous_map_as_event` aggregate plugin option :
+
+[source,ruby]
+----------------------------------
+   filter {
+     aggregate {
+       task_id => "%{country_name}"
+       code => "
+         map['country_name'] = event.get('country_name')
+         map['towns'] ||= []
+         map['towns'] << {'town_name' => event.get('town_name')}
+         event.cancel()
+       "
+       push_previous_map_as_event => true
+       timeout => 3
+     }
+   }
+----------------------------------
+
+* The key point is that each time aggregate plugin detects a new `country_name`, it pushes previous aggregate map as a new Logstash event, and then creates a new empty map for the next country
+* When 5s timeout comes, the last aggregate map is pushed as a new event
+* Finally, initial events (which are not aggregated) are dropped because useless (thanks to `event.cancel()`)
+
+
+[id="plugins-{type}s-{plugin}-example5"]
+==== Example #5 : no end event and push events as soon as possible
+
+Fifth use case: like example #3, there is no end event. +
+Events keep comming for an indefinite time and you want to push the aggregation map as soon as possible after the last user interaction without waiting for the `timeout`. +
+This allows to have the aggregated events pushed closer to real time. +
+
+A typical case is aggregating or tracking user behaviour. +
+We can track a user by its ID through the events, however once the user stops interacting, the events stop coming in. +
+There is no specific event indicating the end of the user's interaction. +
+The user ineraction will be considered as ended when no events for the specified user (task_id) arrive after the specified inactivity_timeout`. +
+If the user continues interacting for longer than `timeout` seconds (since first event), the aggregation map will still be deleted and pushed as a new event when timeout occurs. +
+The difference with example #3 is that the events will be pushed as soon as the user stops interacting for `inactivity_timeout` seconds instead of waiting for the end of `timeout` seconds since first event.
+
+In this case, we can enable the option 'push_map_as_event_on_timeout' to enable pushing the aggregation map as a new event when inactivity timeout occurs. +
+In addition, we can enable 'timeout_code' to execute code on the populated timeout event. +
+We can also add 'timeout_task_id_field' so we can correlate the task_id, which in this case would be the user's ID. +
+
+* Given these logs:
+
+[source,ruby]
+----------------------------------
+INFO - 12345 - Clicked One
+INFO - 12345 - Clicked Two
+INFO - 12345 - Clicked Three
+----------------------------------
+
+* You can aggregate the amount of clicks the user did like this:
+
+[source,ruby]
+----------------------------------
+filter {
+ grok {
+   match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:user_id} - %{GREEDYDATA:msg_text}" ]
+ }
+ aggregate {
+   task_id => "%{user_id}"
+   code => "map['clicks'] ||= 0; map['clicks'] += 1;"
+   push_map_as_event_on_timeout => true
+   timeout_task_id_field => "user_id"
+   timeout => 3600 # 1 hour timeout, user activity will be considered finished one hour after the first event, even if events keep comming
+   inactivity_timeout => 300 # 5 minutes timeout, user activity will be considered finished if no new events arrive 5 minutes after the last event
+   timeout_tags => ['_aggregatetimeout']
+   timeout_code => "event.set('several_clicks', event.get('clicks') > 1)"
+ }
+}
+----------------------------------
+
+* After five minutes of inactivity or one hour since first event, this will yield an event like:
+
+[source,json]
+----------------------------------
+{
+ "user_id": "12345",
+ "clicks": 3,
+ "several_clicks": true,
+   "tags": [
+      "_aggregatetimeout"
+   ]
+}
+----------------------------------
+
+
+[id="plugins-{type}s-{plugin}-howitworks"]
+==== How it works
+* the filter needs a "task_id" to correlate events (log lines) of a same task
+* at the task beggining, filter creates a map, attached to task_id
+* for each event, you can execute code using 'event' and 'map' (for instance, copy an event field to map)
+* in the final event, you can execute a last code (for instance, add map data to final event)
+* after the final event, the map attached to task is deleted (thanks to `end_of_task => true`)
+* an aggregate map is tied to one task_id value which is tied to one task_id pattern. So if you have 2 filters with different task_id patterns, even if you have same task_id value, they won't share the same aggregate map.
+* in one filter configuration, it is recommanded to define a timeout option to protect the feature against unterminated tasks. It tells the filter to delete expired maps
+* if no timeout is defined, by default, all maps older than 1800 seconds are automatically deleted
+* all timeout options have to be defined in only one aggregate filter per task_id pattern. Timeout options are : timeout, inactivity_timeout, timeout_code, push_map_as_event_on_timeout, push_previous_map_as_event, timeout_task_id_field, timeout_tags
+* if `code` execution raises an exception, the error is logged and event is tagged '_aggregateexception'
+
+
+[id="plugins-{type}s-{plugin}-usecases"]
+==== Use Cases
+* extract some cool metrics from task logs and push them into task final log event (like in example #1 and #2)
+* extract error information in any task log line, and push it in final task event (to get a final event with all error information if any)
+* extract all back-end calls as a list, and push this list in final task event (to get a task profile)
+* extract all http headers logged in several lines to push this list in final task event (complete http request info)
+* for every back-end call, collect call details available on several lines, analyse it and finally tag final back-end call log line (error, timeout, business-warning, ...)
+* Finally, task id can be any correlation id matching your need : it can be a session id, a file path, ...
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Aggregate Filter Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-aggregate_maps_path>> |<<string,string>>, a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-code>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-end_of_task>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-inactivity_timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-map_action>> |<<string,string>>, one of `["create", "update", "create_or_update"]`|No
+| <<plugins-{type}s-{plugin}-push_map_as_event_on_timeout>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-push_previous_map_as_event>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-task_id>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-timeout_code>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-timeout_tags>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-timeout_task_id_field>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-aggregate_maps_path"]
+===== `aggregate_maps_path`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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:
+[source,ruby]
+    filter {
+      aggregate {
+        aggregate_maps_path => "/path/to/.aggregate_maps"
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-code"]
+===== `code`
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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:
+[source,ruby]
+    filter {
+      aggregate {
+        code => "map['sql_duration'] += event.get('duration')"
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-end_of_task"]
+===== `end_of_task`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Tell the filter that task is ended, and therefore, to delete aggregate map after code execution.
+
+[id="plugins-{type}s-{plugin}-inactivity_timeout"]
+===== `inactivity_timeout`
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+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`.
+
+[id="plugins-{type}s-{plugin}-map_action"]
+===== `map_action`
+
+  * Value type is <<string,string>>
+  * Default value is `"create_or_update"`
+
+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
+
+[id="plugins-{type}s-{plugin}-push_map_as_event_on_timeout"]
+===== `push_map_as_event_on_timeout`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+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.
+
+[id="plugins-{type}s-{plugin}-push_previous_map_as_event"]
+===== `push_previous_map_as_event`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+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.
+
+WARNING: this option works fine only if tasks come one after the other. It means : all task1 events, then all task2 events, etc...
+
+[id="plugins-{type}s-{plugin}-task_id"]
+===== `task_id`
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The expression defining task ID to correlate logs.
+
+This value must uniquely identify the task.
+
+Example:
+[source,ruby]
+    filter {
+      aggregate {
+        task_id => "%{type}%{my_task_id}"
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-timeout"]
+===== `timeout`
+
+  * Value type is <<number,number>>
+  * Default value is `1800`
+
+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.
+
+[id="plugins-{type}s-{plugin}-timeout_code"]
+===== `timeout_code`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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:
+[source,ruby]
+    filter {
+      aggregate {
+        timeout_code => "event.set('state', 'timeout')"
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-timeout_tags"]
+===== `timeout_tags`
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+Defines tags to add when a timeout event is generated and yield
+
+Example:
+[source,ruby]
+    filter {
+      aggregate {
+        timeout_tags => ["aggregate_timeout']
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-timeout_task_id_field"]
+===== `timeout_task_id_field`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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.
+
+For example, with option `timeout_task_id_field => "my_id"` ,when timeout task id is `"12345"`, the generated timeout event will contain `'my_id' => '12345'`.
+
+By default, if this option is not set, task id value won't be set into timeout generated event.
+
+
+
+include::{include_path}/{type}.asciidoc[]