logstash-filter-aggregate 2.9.2 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15460afa4f78789d3f4ee56ae45e06e5f31b8ef4
-  data.tar.gz: f4bd241aa7207b29366d2456d6c42cb6ecc499c3
+  metadata.gz: e30c90c81bac3cd99cf2a01d8e66e010a89acf87
+  data.tar.gz: 5733c4b4a64b9a6b7032fd093f289ad0d2e84f2e
 SHA512:
-  metadata.gz: 10f18942af2c7cd6f343502478d6d6d2ffc530700b9462e377770a0adbd6bb38b71c2a7debeeaba832aa0aafa9eba85acd041c35a468f2876ad61d0a51566f40
-  data.tar.gz: d6c92aa3b6bf04bfdd1be6e6b3fafbeb8b31416e20db4ee2c795d3fa20ac193db9a8422634b90df90efed88f135e5941a2f7373707b0e20be886a68a30abd8c7
+  metadata.gz: 809dbbdba440d501fb460ab5d60cbaaabb397654a054cd668a2d38ed1de31b99876839896cbd0c16634572d702ba8e944f094616d95e916935009a3290de8d36
+  data.tar.gz: 6cb68ae7e22433d0bc0a49803a95e1836de98f8bb36c937812b2bbb6981d5624590df1ce27694ee34cb7fef53774ab18e9b823b0253b62c3687ea8f83895b82e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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

data/docs/index.asciidoc

@@ -402,7 +402,7 @@ 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 :
+Available variables are:
 
 `event`: current Logstash event
 
@@ -411,8 +411,11 @@ Available variables are :
 `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.
 
+
 Example:
 [source,ruby]
     filter {
@@ -421,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

@@ -83,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, map_meta| #{@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
@@ -168,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)
@@ -213,7 +213,7 @@ class LogStash::Filters::Aggregate < LogStash::Filters::Base
       # execute the code to read/update map and event
       map = aggregate_maps_element.map
       begin
-        @codeblock.call(event, map, aggregate_maps_element)
+        @codeblock.call(event, map, aggregate_maps_element, &new_event_block)
         @logger.debug("Aggregate successful filter code execution", :code => @code)
         noError = true
       rescue => exception

data/logstash-filter-aggregate.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-aggregate'
-  s.version         = '2.9.2'
-  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

@@ -420,4 +420,17 @@ describe LogStash::Filters::Aggregate do
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-aggregate
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 2.10.0
 platform: ruby
 authors:
 - Elastic
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-25 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