logstash-filter-aggregate 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cbb27a58c0339ae9f7908d18250a5f91c456f6f
-  data.tar.gz: e86b38aa410918fb62cf7050be5fd8b9f44d6ed9
+  metadata.gz: e30c90c81bac3cd99cf2a01d8e66e010a89acf87
+  data.tar.gz: 5733c4b4a64b9a6b7032fd093f289ad0d2e84f2e
 SHA512:
-  metadata.gz: d14e1e14cdf0342db92e06ceac124f4c0d384183e4074f7da55b87e27d117d4feddc63844b3a7b06b196d704154a44005bae18e8b3f135d8008f877ef6bafe76
-  data.tar.gz: 090d1e070fab264a8f4b1c7150e6d4161e357ab146cc0303480cc6ee0aebdcba80659f9a7dba02ffadf0939f47140a7038f83aa571b9053e2cd9d1fb58a2b91f
+  metadata.gz: 809dbbdba440d501fb460ab5d60cbaaabb397654a054cd668a2d38ed1de31b99876839896cbd0c16634572d702ba8e944f094616d95e916935009a3290de8d36
+  data.tar.gz: 6cb68ae7e22433d0bc0a49803a95e1836de98f8bb36c937812b2bbb6981d5624590df1ce27694ee34cb7fef53774ab18e9b823b0253b62c3687ea8f83895b82e

data/CHANGELOG.md

@@ -1,9 +1,29 @@
+## 2.10.0
+  - new feature: add ability to generate new event during code execution (#116)
+
+## 2.9.2
+  - bugfix: remove 'default_timeout' at pipeline level (fix #112)
+  - ci: update travis ci configuration
+
+## 2.9.1
+  - bugfix: fix inactivity timeout feature when processing old logs (PR [#103](https://github.com/logstash-plugins/logstash-filter-aggregate/pull/103), thanks @jdratlif for his contribution!)
+  - docs: fix several typos in documentation
+  - docs: enhance example 4 documentation
+  - ci: enhance plugin continuous integration
+
+## 2.9.0
+  - new feature: add ability to dynamically define a custom `timeout` or `inactivity_timeout` in `code` block (fix issues [#91](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/91) and [#92](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/92))
+  - new feature: add meta informations available in `code` block through `map_meta` variable
+  - new feature: add Logstash metrics, specific to aggregate plugin: aggregate_maps, pushed_events, task_timeouts, code_errors, timeout_code_errors
+  - new feature: validate at startup that `map_action` option equals to 'create', 'update' or 'create_or_update'
+
 ## 2.8.0
-  - new feature: add 'timeout_timestamp_field' option.  
-    When set, this option lets to compute timeout based on event timestamp field (and not system time). It's particularly useful when processing old logs.
+  - new feature: add 'timeout_timestamp_field' option (fix issue [#81](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/81))  
+    When set, this option lets to compute timeout based on event timestamp field (and not system time).  
+    It's particularly useful when processing old logs.
 
 ## 2.7.2
-  - bugfix: fix synchronisation issue at Logstash shutdown (#75)
+  - bugfix: fix synchronisation issue at Logstash shutdown (issue [#75](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/75))
 
 ## 2.7.1
   - docs: update gemspec summary
@@ -32,7 +52,7 @@
   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
+- bugfix: fix 'aggregate_maps_path' load (issue [#62](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/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)
 - docs: enhance examples
 - docs: precise that tasks are tied to their task_id pattern, even if they have same task_id value
@@ -50,7 +70,7 @@
  - breaking: need Logstash 2.4 or later  
 
 ## 2.4.0
- - new feature: You can now define timeout options per task_id pattern (#42)  
+ - new feature: You can now define timeout options per task_id pattern (fix issue [#42](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/42))  
  timeout options are : `timeout, timeout_code, push_map_as_event_on_timeout, push_previous_map_as_event, timeout_task_id_field, timeout_tags`
  - validation: a configuration error is thrown at startup if you define any timeout option on several aggregate filters for the same task_id pattern
  - breaking: if you use `aggregate_maps_path` option, storage format has changed. So you have to delete `aggregate_maps_path` file before starting Logstash
@@ -84,14 +104,14 @@
  - internal,deps: New dependency requirements for logstash-core for the 5.0 release
 
 ## 2.0.3
- - bugfix: fix issue #10 : numeric task_id is now well processed
+ - bugfix: fix issue [#10](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/10) : numeric task_id is now well processed
 
 ## 2.0.2
- - bugfix: fix issue #5 : when code call raises an exception, the error is logged and the event is tagged '_aggregateexception'. It avoids logstash crash.
+ - bugfix: fix issue [#5](https://github.com/logstash-plugins/logstash-filter-aggregate/issues/5) : when code call raises an exception, the error is logged and the event is tagged '_aggregateexception'. It avoids logstash crash.
 
 ## 2.0.0
- - internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
-   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, instead of using Thread.raise on the plugins' threads.  
+   Ref: https://github.com/elastic/logstash/pull/3895
  - internal,deps: Dependency on logstash-core update to 2.0
 
 ## 0.1.3

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 Elasticsearch <http://www.elasticsearch.org>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-aggregate.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-aggregate)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -228,7 +228,7 @@ In that case, you don't want to wait task timeout to flush aggregation map.
      aggregate {
        task_id => "%{country_name}"
        code => "
-         map['country_name'] = event.get('country_name')
+         map['country_name'] ||= event.get('country_name')
          map['towns'] ||= []
          map['towns'] << {'town_name' => event.get('town_name')}
          event.cancel()
@@ -240,8 +240,9 @@ In that case, you don't want to wait task timeout to flush aggregation map.
 ----------------------------------
 
 * 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()`)
+* When 3s timeout comes, the last aggregate map is pushed as a new event
+* Initial events (which are not aggregated) are dropped because useless (thanks to `event.cancel()`)
+* Last point: if a field is not fulfilled for every event (say "town_postcode" field), the `||=` operator will let you to push into aggregate map, the first "not null" value. Example: `map['town_postcode'] ||= event.get('town_postcode')`
 
 
 [id="plugins-{type}s-{plugin}-example5"]
@@ -249,7 +250,7 @@ In that case, you don't want to wait task timeout to flush aggregation map.
 
 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`.
+Events keep coming 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.
 
@@ -260,7 +261,7 @@ We can track a user by its ID through the events, however once the user stops 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`.
+The user interaction 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.
 
@@ -295,7 +296,7 @@ filter {
    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
+   timeout => 3600 # 1 hour timeout, user activity will be considered finished one hour after the first event, even if events keep coming
    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)"
@@ -326,7 +327,7 @@ filter {
 * 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
+* in one filter configuration, it is recommended 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 (per pipeline). Timeout options are : timeout, inactivity_timeout, timeout_code, push_map_as_event_on_timeout, push_previous_map_as_event, timeout_timestamp_field, timeout_task_id_field, timeout_tags
 * if `code` execution raises an exception, the error is logged and event is tagged '_aggregateexception'
@@ -397,11 +398,23 @@ Example:
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-The code to execute to update map, using current event.
+The code to execute to update aggregated map, using current event.
 
-Or on the contrary, the code to execute to update event, using current map.
+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 http://ruby-doc.org/core-1.9.1/Hash.html[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`.
+
+`new_event_block`: block used to emit new Logstash events. See the second example on how to use it.
+
+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.
 
-You will have a 'map' variable and an 'event' variable available (that is the event itself).
 
 Example:
 [source,ruby]
@@ -411,6 +424,26 @@ Example:
       }
     }
 
+
+To create additional events during the code execution, to be emitted immediately, you can use `new_event_block.call(event)` function, like in the following example:
+
+[source,ruby]
+    filter {
+      aggregate {
+        code => "
+            data = {:my_sql_duration => map['sql_duration']}
+            generated_event = LogStash::Event.new(data)
+            generated_event.set('my_other_field', 34)
+            new_event_block.call(generated_event)
+        "
+      }
+    }
+
+The parameter of the function `new_event_block.call` must be of type `LogStash::Event`.  
+To create such an object, the constructor of the same class can be used: `LogStash::Event.new()`.  
+`LogStash::Event.new()` can receive a parameter of type ruby http://ruby-doc.org/core-1.9.1/Hash.html[Hash] to initialize the new event fields.
+
+
 [id="plugins-{type}s-{plugin}-end_of_task"]
 ===== `end_of_task`
 

data/lib/logstash/filters/aggregate.rb

@@ -20,7 +20,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
   config :code, :validate => :string, :required => true
 
-  config :map_action, :validate => :string, :default => "create_or_update"
+  config :map_action, :validate => ["create", "update", "create_or_update"], :default => "create_or_update"
 
   config :end_of_task, :validate => :boolean, :default => false
 
@@ -51,6 +51,8 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
   # pointer to current pipeline context
   attr_accessor :current_pipeline
 
+  # boolean indicating if expired maps should be checked on every flush call (typically because custom timeout has beeen set on a map)
+  attr_accessor :check_expired_maps_on_every_flush
 
   # ################ #
   # STATIC VARIABLES #
@@ -81,7 +83,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
     end
 
     # process lambda expression to call in each filter call
-    eval("@codeblock = lambda { |event, map| #{@code} }", binding, "(aggregate filter code)")
+    eval("@codeblock = lambda { |event, map, map_meta, &new_event_block| #{@code} }", binding, "(aggregate filter code)")
 
     # process lambda expression to call in the timeout case or previous event case
     if @timeout_code
@@ -104,15 +106,9 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
         @logger.debug("Aggregate timeout for '#{@task_id}' pattern: #{@timeout} seconds")
       end
 
-      # timeout management : define default_timeout
-      if @timeout && (@current_pipeline.default_timeout.nil? || @timeout < @current_pipeline.default_timeout)
-        @current_pipeline.default_timeout = @timeout
-        @logger.debug("Aggregate default timeout: #{@timeout} seconds")
-      end
-
       # inactivity timeout management: make sure it is lower than timeout
-      if @inactivity_timeout && ((@timeout && @inactivity_timeout > @timeout) || (@current_pipeline.default_timeout && @inactivity_timeout > @current_pipeline.default_timeout))
-        raise LogStash::ConfigurationError, "Aggregate plugin: For task_id pattern #{@task_id}, inactivity_timeout must be lower than timeout"
+      if @inactivity_timeout && ((@timeout && @inactivity_timeout > @timeout) || (@timeout.nil? && @inactivity_timeout > DEFAULT_TIMEOUT))
+        raise LogStash::ConfigurationError, "Aggregate plugin: For task_id pattern #{@task_id}, inactivity_timeout (#{@inactivity_timeout}) must be lower than timeout (#{@timeout})"
       end
 
       # reinit pipeline_close_instance (if necessary)
@@ -140,6 +136,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
       # init aggregate_maps
       @current_pipeline.aggregate_maps[@task_id] ||= {}
+      update_aggregate_maps_metric()
 
     end
   end
@@ -171,7 +168,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
   # This method is invoked each time an event matches the filter
   public
-  def filter(event)
+  def filter(event, &new_event_block)
 
     # define task id
     task_id = event.sprintf(@task_id)
@@ -202,19 +199,21 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
         # create aggregate map
         creation_timestamp = reference_timestamp(event)
-        aggregate_maps_element = LogStash::Filters::Aggregate::Element.new(creation_timestamp)
+        aggregate_maps_element = LogStash::Filters::Aggregate::Element.new(creation_timestamp, task_id)
         @current_pipeline.aggregate_maps[@task_id][task_id] = aggregate_maps_element
+        update_aggregate_maps_metric()
       else
         return if @map_action == "create"
       end
 
       # update last event timestamp
       aggregate_maps_element.lastevent_timestamp = reference_timestamp(event)
+      aggregate_maps_element.difference_from_lastevent_to_now = (Time.now - aggregate_maps_element.lastevent_timestamp).to_i
 
       # execute the code to read/update map and event
       map = aggregate_maps_element.map
       begin
-        @codeblock.call(event, map)
+        @codeblock.call(event, map, aggregate_maps_element, &new_event_block)
         @logger.debug("Aggregate successful filter code execution", :code => @code)
         noError = true
       rescue => exception
@@ -224,10 +223,17 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
                       :map => map,
                       :event_data => event.to_hash_with_metadata)
         event.tag("_aggregateexception")
+        metric.increment(:code_errors)
       end
 
       # delete the map if task is ended
       @current_pipeline.aggregate_maps[@task_id].delete(task_id) if @end_of_task
+      update_aggregate_maps_metric()
+
+      # process custom timeout set by code block
+      if (aggregate_maps_element.timeout || aggregate_maps_element.inactivity_timeout)
+        event_to_yield = process_map_timeout(aggregate_maps_element)
+      end
 
     end
 
@@ -238,6 +244,25 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
     yield event_to_yield if event_to_yield
   end
 
+  # Process a custom timeout defined in aggregate map element
+  # Returns an event to yield if timeout=0 and push_map_as_event_on_timeout=true
+  def process_map_timeout(element)
+    event_to_yield = nil
+    init_pipeline_timeout_management()
+    if (element.timeout == 0 || element.inactivity_timeout == 0)
+      @current_pipeline.aggregate_maps[@task_id].delete(element.task_id)
+      if @current_pipeline.flush_instance_map[@task_id].push_map_as_event_on_timeout
+        event_to_yield = create_timeout_event(element.map, element.task_id)
+      end
+      @logger.debug("Aggregate remove expired map with task_id=#{element.task_id} and custom timeout=0")
+      metric.increment(:task_timeouts)
+      update_aggregate_maps_metric()
+    else
+      @current_pipeline.flush_instance_map[@task_id].check_expired_maps_on_every_flush ||= true
+    end
+    return event_to_yield
+  end
+
   # Create a new event from the aggregation_map and the corresponding task_id
   # This will create the event and
   #  if @timeout_task_id_field is set, it will set the task_id on the timeout event
@@ -255,7 +280,8 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
     LogStash::Util::Decorators.add_tags(@timeout_tags, event_to_yield, "filters/#{self.class.name}")
 
-    # Call code block if available
+
+    # Call timeout code block if available
     if @timeout_code
       begin
         @timeout_codeblock.call(event_to_yield)
@@ -265,9 +291,12 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
                       :timeout_code => @timeout_code,
                       :timeout_event_data => event_to_yield.to_hash_with_metadata)
         event_to_yield.tag("_aggregateexception")
+        metric.increment(:timeout_code_errors)
       end
     end
 
+    metric.increment(:pushed_events)
+
     return event_to_yield
   end
 
@@ -276,6 +305,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
     previous_entry = @current_pipeline.aggregate_maps[@task_id].shift()
     previous_task_id = previous_entry[0]
     previous_map = previous_entry[1].map
+    update_aggregate_maps_metric()
     return create_timeout_event(previous_map, previous_task_id)
   end
 
@@ -287,13 +317,13 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
   # This method is invoked by LogStash every 5 seconds.
   def flush(options = {})
 
-    @logger.debug("Aggregate flush call with #{options}")
+    @logger.trace("Aggregate flush call with #{options}")
 
     # init flush/timeout properties for current pipeline
     init_pipeline_timeout_management()
     
     # launch timeout management only every interval of (@inactivity_timeout / 2) seconds or at Logstash shutdown
-    if @current_pipeline.flush_instance_map[@task_id] == self && @current_pipeline.aggregate_maps[@task_id] && (!@current_pipeline.last_flush_timestamp_map.has_key?(@task_id) || Time.now > @current_pipeline.last_flush_timestamp_map[@task_id] + @inactivity_timeout / 2 || options[:final])
+    if @current_pipeline.flush_instance_map[@task_id] == self && @current_pipeline.aggregate_maps[@task_id] && (!@current_pipeline.last_flush_timestamp_map.has_key?(@task_id) || Time.now > @current_pipeline.last_flush_timestamp_map[@task_id] + @inactivity_timeout / 2 || options[:final] || @check_expired_maps_on_every_flush)
       events_to_flush = remove_expired_maps()
 
       # at Logstash shutdown, if push_previous_map_as_event is enabled, it's important to force flush (particularly for jdbc input plugin)
@@ -302,6 +332,8 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
           events_to_flush << extract_previous_map_as_event()
         end
       end
+      
+      update_aggregate_maps_metric()
 
       # tag flushed events, indicating "final flush" special event
       if options[:final]
@@ -321,11 +353,6 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
   # init flush/timeout properties for current pipeline
   def init_pipeline_timeout_management()
     
-    # Define default timeout (if not defined by user)
-    if @current_pipeline.default_timeout.nil?
-      @current_pipeline.default_timeout = DEFAULT_TIMEOUT
-    end
-    
     # Define default flush instance that manages timeout (if not defined by user)
     if !@current_pipeline.flush_instance_map.has_key?(@task_id)
       @current_pipeline.flush_instance_map[@task_id] = self
@@ -334,7 +361,8 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
     # Define timeout and inactivity_timeout (if not defined by user)
     if @current_pipeline.flush_instance_map[@task_id] == self
       if @timeout.nil?
-        @timeout = @current_pipeline.default_timeout
+        @timeout = DEFAULT_TIMEOUT
+        @logger.debug("Aggregate timeout for '#{@task_id}' pattern: #{@timeout} seconds (default value)")
       end
       if @inactivity_timeout.nil?
         @inactivity_timeout = @timeout
@@ -347,23 +375,32 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
   # If @push_previous_map_as_event option is set, or @push_map_as_event_on_timeout is set, expired maps are returned as new events to be flushed to Logstash pipeline.
   def remove_expired_maps()
     events_to_flush = []
-    min_timestamp = Time.now - @timeout
-    min_inactivity_timestamp = Time.now - @inactivity_timeout
+    default_min_timestamp = Time.now - @timeout
+    default_min_inactivity_timestamp = Time.now - @inactivity_timeout
 
     @current_pipeline.mutex.synchronize do
 
       @logger.debug("Aggregate remove_expired_maps call with '#{@task_id}' pattern and #{@current_pipeline.aggregate_maps[@task_id].length} maps")
 
       @current_pipeline.aggregate_maps[@task_id].delete_if do |key, element|
-        if element.creation_timestamp + element.difference_from_creation_to_now < min_timestamp || element.lastevent_timestamp + element.difference_from_creation_to_now < min_inactivity_timestamp
+        min_timestamp = element.timeout ? Time.now - element.timeout : default_min_timestamp
+        min_inactivity_timestamp = element.inactivity_timeout ? Time.now - element.inactivity_timeout : default_min_inactivity_timestamp
+        if element.creation_timestamp + element.difference_from_creation_to_now < min_timestamp || element.lastevent_timestamp + element.difference_from_lastevent_to_now < min_inactivity_timestamp
           if @push_previous_map_as_event || @push_map_as_event_on_timeout
             events_to_flush << create_timeout_event(element.map, key)
           end
+          @logger.debug("Aggregate remove expired map with task_id=#{key}")
+          metric.increment(:task_timeouts)
           next true
         end
         next false
       end
     end
+    
+    # disable check_expired_maps_on_every_flush if there is not anymore maps
+    if @current_pipeline.aggregate_maps[@task_id].length == 0 && @check_expired_maps_on_every_flush
+      @check_expired_maps_on_every_flush = nil
+    end
 
     return events_to_flush
   end
@@ -382,14 +419,16 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
     event_to_flush = nil
     event_timestamp = reference_timestamp(event)
-    min_timestamp = event_timestamp - @timeout
-    min_inactivity_timestamp = event_timestamp - @inactivity_timeout
+    min_timestamp = element.timeout ? event_timestamp - element.timeout : event_timestamp - @timeout
+    min_inactivity_timestamp = element.inactivity_timeout ? event_timestamp - element.inactivity_timeout : event_timestamp - @inactivity_timeout
 
     if element.creation_timestamp < min_timestamp || element.lastevent_timestamp < min_inactivity_timestamp
       if @push_previous_map_as_event || @push_map_as_event_on_timeout
         event_to_flush = create_timeout_event(element.map, task_id)
       end
       @current_pipeline.aggregate_maps[@task_id].delete(task_id)
+      @logger.debug("Aggregate remove expired map with task_id=#{task_id}")
+      metric.increment(:task_timeouts)
     end
 
     return event_to_flush
@@ -428,7 +467,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
     if @execution_context
       return @execution_context.pipeline_id
     else
-      return pipeline_id = "main"
+      return "main"
     end
   end
 
@@ -438,17 +477,29 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
     return (@timeout_timestamp_field) ? event.get(@timeout_timestamp_field).time : Time.now
   end
 
+  # update "aggregate_maps" metric, with aggregate maps count associated to configured taskid pattern 
+  def update_aggregate_maps_metric()
+    aggregate_maps = @current_pipeline.aggregate_maps[@task_id]
+    if aggregate_maps
+      metric.gauge(:aggregate_maps, aggregate_maps.length)
+    end
+  end
+
 end # class LogStash::Filters::Aggregate
 
 # Element of "aggregate_maps"
 class LogStash::Filters::Aggregate::Element
 
-  attr_accessor :creation_timestamp, :lastevent_timestamp, :difference_from_creation_to_now, :map
+  attr_accessor :creation_timestamp, :lastevent_timestamp, :difference_from_creation_to_now, :difference_from_lastevent_to_now, :timeout, :inactivity_timeout, :task_id, :map
 
-  def initialize(creation_timestamp)
+  def initialize(creation_timestamp, task_id)
     @creation_timestamp = creation_timestamp
-    @lastevent_timestamp = creation_timestamp
+    @lastevent_timestamp = creation_timestamp    
     @difference_from_creation_to_now = (Time.now - creation_timestamp).to_i
+    @difference_from_lastevent_to_now = @difference_from_creation_to_now
+    @timeout = nil
+    @inactivity_timeout = nil
+    @task_id = task_id
     @map = {}
   end
 end
@@ -456,7 +507,7 @@ end
 # shared aggregate attributes for each pipeline
 class LogStash::Filters::Aggregate::Pipeline
 
-  attr_accessor :aggregate_maps, :mutex, :default_timeout, :flush_instance_map, :last_flush_timestamp_map, :aggregate_maps_path_set, :pipeline_close_instance
+  attr_accessor :aggregate_maps, :mutex, :flush_instance_map, :last_flush_timestamp_map, :aggregate_maps_path_set, :pipeline_close_instance
 
   def initialize()
     # Stores all aggregate maps, per task_id pattern, then per task_id value
@@ -465,9 +516,6 @@ class LogStash::Filters::Aggregate::Pipeline
     # Mutex used to synchronize access to 'aggregate_maps'
     @mutex = Mutex.new
 
-    # Default timeout for task_id patterns where timeout is not defined in Logstash filter configuration
-    @default_timeout = nil
-
     # For each "task_id" pattern, defines which Aggregate instance will process flush() call, processing expired Aggregate elements (older than timeout)
     # For each entry, key is "task_id pattern" and value is "aggregate instance"
     @flush_instance_map = {}

data/logstash-filter-aggregate.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-aggregate'
-  s.version         = '2.8.0'
-  s.licenses = ['Apache License (2.0)']
-  s.summary = "Aggregates information from several events originating with a single task"
+  s.version = '2.10.0'
+  s.licenses = ['Apache-2.0']
+  s.summary = 'Aggregates information from several events originating with a single task'
   s.description = 'This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'
   s.authors = ['Elastic', 'Fabien Baligand']
   s.email = 'info@elastic.co'

data/spec/filters/aggregate_spec.rb

@@ -389,4 +389,48 @@ describe LogStash::Filters::Aggregate do
     end
   end
 
-end
+  context "custom timeout on map_meta, " do
+    describe "when map_meta.timeout=0, " do
+      it "should push a new aggregated event immediately" do
+        agg_filter = setup_filter({ "task_id" => "%{ppm_id}", "code" => "map['sql_duration'] = 2; map_meta.timeout = 0", "push_map_as_event_on_timeout" => true, "timeout" => 120 })
+        agg_filter.filter(event({"ppm_id" => "1"})) do |yield_event| 
+          expect(yield_event).not_to be_nil
+          expect(yield_event.get("sql_duration")).to eq(2)
+        end
+        expect(aggregate_maps["%{ppm_id}"]).to be_empty
+      end
+    end
+    describe "when map_meta.timeout=0 and push_map_as_event_on_timeout=false, " do
+      it "should just remove expired map and not push an aggregated event" do
+        agg_filter = setup_filter({ "task_id" => "%{ppm_id}", "code" => "map_meta.timeout = 0", "push_map_as_event_on_timeout" => false, "timeout" => 120 })
+        agg_filter.filter(event({"ppm_id" => "1"}))  { |yield_event| fail "it shouldn't have yield event" } 
+        expect(aggregate_maps["%{ppm_id}"]).to be_empty
+      end
+    end
+    describe "when map_meta.inactivity_timeout=1, " do
+      it "should push a new aggregated event at next flush call" do
+        agg_filter = setup_filter({ "task_id" => "%{ppm_id}", "code" => "map['sql_duration'] = 2; map_meta.inactivity_timeout = 1", "push_map_as_event_on_timeout" => true, "timeout" => 120 })
+        agg_filter.filter(event({"ppm_id" => "1"})) { |yield_event| fail "it shouldn't have yield event" }
+        expect(aggregate_maps["%{ppm_id}"].size).to eq(1)
+        sleep(2)
+        events_to_flush = agg_filter.flush()
+        expect(events_to_flush.size).to eq(1)
+        expect(aggregate_maps["%{ppm_id}"]).to be_empty
+      end
+    end
+  end
+
+  context "Custom event generation code is used" do
+    describe "when a new event is manually generated" do
+      it "should push a new event immediately" do
+        agg_filter = setup_filter({ "task_id" => "%{task_id}", "code" => "map['sql_duration'] = 2; new_event_block.call(LogStash::Event.new({:my_sql_duration => map['sql_duration']}))", "timeout" => 120 })
+        agg_filter.filter(event({"task_id" => "1"})) do |yield_event|
+          expect(yield_event).not_to be_nil
+          expect(yield_event.get("my_sql_duration")).to eq(2)
+        end
+      end
+    end
+
+  end
+
+end

data/spec/filters/aggregate_spec_helper.rb

@@ -62,7 +62,6 @@ def aggregate_maps_path_set()
 end
 
 def reset_timeout_management()
-  current_pipeline().default_timeout = nil
   current_pipeline().flush_instance_map.clear()
   current_pipeline().last_flush_timestamp_map.clear()
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-aggregate
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Elastic
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +45,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
+  gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
@@ -65,7 +67,7 @@ files:
 - spec/filters/aggregate_spec_helper.rb
 homepage: https://github.com/logstash-plugins/logstash-filter-aggregate
 licenses:
-- Apache License (2.0)
+- Apache-2.0
 metadata:
   logstash_plugin: 'true'
   logstash_group: filter
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14.1
 signing_key:
 specification_version: 4
 summary: Aggregates information from several events originating with a single task