logstash-filter-foreach 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1b8b2c855be5f253874cafd451a67f956c728b8b
-  data.tar.gz: df60708d67752cb1541edd95b99d517e749e9718
+SHA256:
+  metadata.gz: '060786427644bdb8d829fd5f6f44adca1b1f7a48a3b0cea726cc1b3a92c71f1d'
+  data.tar.gz: 78ebd5c7a394f5ffa1ebbe7a3bc84506f4f1d25cca0f1dca1b1b1eea3937bbb6
 SHA512:
-  metadata.gz: ec0fcfffaa57ac9ed6e7a11f2f0184957750d0f850d04097a63bfe24688ddd8135fe00af967dca878cf2f3998172406a3ece237d71d7585ab774ff041c903c49
-  data.tar.gz: e79445a11ab6e9f7f65eac33364aa1a6d3fb8a123c4761d98640a1cc3f9930b1de2dca32bebc0558bafd5156be426da1b4d792bc3e97aaa242fccddc05362337
+  metadata.gz: 82d2d3c2b1f61085f19e082e2131ef42181608eb711c92e456814d5665def3ee01948f00ff167ce5cd8953c19e97b6e85dfa5810116009e7967f4a76d8c167b2
+  data.tar.gz: 7c3c7960e299d4b3ece6b22bc80520b7eee44cb949ff7ef3d04ea965da26e7fdf10f6a20ffffc53b4d9cf3a29452f3d7907afe1230bcfbb48a09c5af53990f65

data/lib/logstash/filters/foreach.rb

@@ -73,7 +73,7 @@ class LogStash::Filters::Foreach < LogStash::Filters::Base
   public
   def filter(event)
 
-    @logger.debug("Foreach plugin:", :task_id => @task_id, :array_field => @array_field, :join_fields => @join_fields, :end => @end, :timeout => @timeout, :event => event.to_hash)
+    @logger.debug("Foreach plugin:", :task_id => @task_id, :array_field => @array_field, :join_fields => @join_fields, :end => @end, :timeout => @timeout, :event => event.to_hash, :metadata => event.get('@metadata'))
 
     passthrough = false
 
@@ -127,7 +127,7 @@ class LogStash::Filters::Foreach < LogStash::Filters::Base
 
             @logger.trace("Foreach plugin: else !array_field.is_a?(Array)");
 
-            @@event_data[task_id] = LogStash::Filters::Foreach::Element.new(configuration, Time.now(), event.clone, configuration.join_fields)
+            @@event_data[task_id] = LogStash::Filters::Foreach::Element.new(configuration, Time.now(), event.clone, event.get('@metadata').clone, configuration.join_fields)
             event_data = @@event_data[task_id]
 
             if array_field.length == 0
@@ -177,8 +177,9 @@ class LogStash::Filters::Foreach < LogStash::Filters::Base
 
             if event_data.sub_events_count == 0
 
-              filter_matched(event_data.initial_event)
-              yield event_data.initial_event
+              ret_event = event_data.event()
+              filter_matched(ret_event)
+              yield ret_event
               @@event_data.delete(task_id)
 
             else
@@ -197,8 +198,9 @@ class LogStash::Filters::Foreach < LogStash::Filters::Base
                 configuration.join_fields.each do |join_field|
                   event_data.initial_event.set(join_field, event_data.join_fields[join_field])
                 end
-                filter_matched(event_data.initial_event)
-                yield event_data.initial_event
+                ret_event = event_data.event()
+                filter_matched(ret_event)
+                yield ret_event
                 @@event_data.delete(task_id)
               end
 
@@ -273,13 +275,14 @@ end
 
 class LogStash::Filters::Foreach::Element
 
-  attr_accessor :initial_event, :counter, :sub_events_count, :join_fields, :lastevent_timestamp, :configuration
+  attr_accessor :initial_event, :initial_metadata, :counter, :sub_events_count, :join_fields, :lastevent_timestamp, :configuration
 
-  def initialize(configuration, creation_timestamp, event, join_fields)
+  def initialize(configuration, creation_timestamp, event, metadata, join_fields)
     # @creation_timestamp = creation_timestamp
     @configuration = configuration
     @lastevent_timestamp = creation_timestamp
     @initial_event = event
+    @initial_metadata = metadata
     @counter = 0
     @sub_events_count = event.get(configuration.array_field).length
     @join_fields = {}
@@ -287,4 +290,10 @@ class LogStash::Filters::Foreach::Element
       @join_fields[join_field] = []
     end
   end
+
+  def event()
+    e = @initial_event.clone
+    e.set('@metadata', @initial_metadata)
+    return e
+  end
 end

data/logstash-filter-foreach.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-foreach'
-  s.version       = '0.1.2'
+  s.version       = '0.2.0'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Process filters for every array item'
   s.description   = 'Plugin splits event for every item in array, then you could process other filters for every item and then join event back'

data/spec/filters/foreach_spec.rb

@@ -153,6 +153,72 @@ describe LogStash::Filters::Foreach do
       end
     end
 
+    describe "should split and join correctly with nested field" do
+      let(:config) do
+        <<-CONFIG
+        filter {
+          foreach {
+            task_id => "%{task_id}"
+            array_field => "[array][nested]"
+            join_fields => ["join"]
+          }
+
+          mutate {
+            add_field => { "join" => "%{[array][nested]}_changed" }
+          }
+
+          foreach {
+            task_id => "%{task_id}"
+            end => true
+          }
+        }
+        CONFIG
+      end
+
+      sample("task_id" => 1, "array" => {"nested" => ["big", "bird", "sesame street"]}, "unchanged" => "unchanged_value") do
+        insist { subject.is_a?(LogStash::Event) } == true
+        insist { subject.get("[array][nested]").is_a?(Array) } == true
+        insist { subject.get("[array][nested]") } == ["big", "bird", "sesame street"]
+        insist { subject.get("join").is_a?(Array) } == true
+        insist { subject.get("join") } == ["big_changed", "bird_changed", "sesame street_changed"]
+        insist { subject.get("unchanged").is_a?(String) } == true
+        insist { subject.get("unchanged") } == "unchanged_value"
+      end
+    end
+
+    describe "should split and join correctly with array joins" do
+      let(:config) do
+        <<-CONFIG
+        filter {
+          foreach {
+            task_id => "%{task_id}"
+            array_field => "array"
+            join_fields => ["join"]
+          }
+
+          mutate {
+            add_field => { "join" => ["%{array}_changed", "%{array}_changed2"] }
+          }
+
+          foreach {
+            task_id => "%{task_id}"
+            end => true
+          }
+        }
+        CONFIG
+      end
+
+      sample("task_id" => 1, "array" => ["big", "bird", "sesame street"], "unchanged" => "unchanged_value") do
+        insist { subject.is_a?(LogStash::Event) } == true
+        insist { subject.get("array").is_a?(Array) } == true
+        insist { subject.get("array") } == ["big", "bird", "sesame street"]
+        insist { subject.get("join").is_a?(Array) } == true
+        insist { subject.get("join") } == ["big_changed", "big_changed2", "bird_changed", "bird_changed2", "sesame street_changed", "sesame street_changed2"]
+        insist { subject.get("unchanged").is_a?(String) } == true
+        insist { subject.get("unchanged") } == "unchanged_value"
+      end
+    end
+
     describe "should passthrough event with incorrect task_id" do
       let(:config) do
         <<-CONFIG
@@ -364,5 +430,67 @@ describe LogStash::Filters::Foreach do
       end
 
     end
+
+    describe "should work with @metadata fields" do
+      let(:config) do
+        <<-CONFIG
+        filter {
+          foreach {
+            task_id => "%{task_id}"
+            array_field => "array"
+            join_fields => ["join"]
+          }
+
+          mutate {
+            add_field => { "join" => "%{array}_changed" }
+          }
+
+          foreach {
+            task_id => "%{task_id}"
+            end => true
+          }
+        }
+        CONFIG
+      end
+
+      sample("task_id" => 1, "array" => ["big", "bird", "sesame street"], "@metadata" => {"unchanged" => "unchanged_value"}) do
+        insist { subject.is_a?(LogStash::Event) } == true
+        insist { subject.get("array").is_a?(Array) } == true
+        insist { subject.get("array") } == ["big", "bird", "sesame street"]
+        insist { subject.get("join").is_a?(Array) } == true
+        insist { subject.get("join") } == ["big_changed", "bird_changed", "sesame street_changed"]
+        insist { subject.get("@metadata").is_a?(Object) } == true
+        insist { subject.get("[@metadata][unchanged]") } == "unchanged_value"
+      end
+    end
+
+    describe "should pass @metadata fields" do
+      let(:config) do
+        <<-CONFIG
+        filter {
+          foreach {
+            task_id => "%{task_id}"
+            array_field => "array"
+            join_fields => ["join"]
+          }
+
+          mutate {
+            add_field => { "join" => "%{array}_changed" }
+          }
+
+          foreach {
+            task_id => "%{task_id}"
+            end => true
+          }
+        }
+        CONFIG
+      end
+
+      sample("task_id" => 1, "@metadata" => {"unchanged" => "unchanged_value"}) do
+        insist { subject.is_a?(LogStash::Event) } == true
+        insist { subject.get("@metadata").is_a?(Object) } == true
+        insist { subject.get("[@metadata][unchanged]") } == "unchanged_value"
+      end
+    end
   end
 end

metadata

@@ -1,75 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-foreach
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - IIIEII
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :runtime
+  name: logstash-core-plugin-api
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: logstash-filter-mutate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: logstash-filter-mutate
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: logstash-filter-drop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: logstash-filter-drop
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
-  type: :development
+  name: logstash-devutils
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
 description: Plugin splits event for every item in array, then you could process other
@@ -95,24 +95,24 @@ licenses:
 metadata:
   logstash_plugin: 'true'
   logstash_group: filter
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
 specification_version: 4
 summary: Process filters for every array item
 test_files: