logstash-filter-mutate 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d864cb702460a9b6b7ab2d3bcf7983df039730306118771e0e62e2f87754c31c
-  data.tar.gz: ee2729fb05d2a18426d8419b917df4137ca90bfd5e45fa4a99a1f32e2ebb5317
+  metadata.gz: 69f20a428551c3f5ddd1667b08cc5b8138f66f8e966aeb797ccda27684dd4e13
+  data.tar.gz: 0c0875f25f5feb9beba83a08ddb0c1576f11a72c3596c2d0c4fd7acc3ac715ed
 SHA512:
-  metadata.gz: 0e01156ec1b9be737f2a291a95a270a1a07e90fac8e62ffbebbc1a81db9d983bda817a7539bd9827b4d919abe4defe6cbf1d3755d51e38c76c26a520d90846ca
-  data.tar.gz: 7998a5a7475514816ab8d83f3749dcb7a54c88a2f510da66b57711c4b7282be70b4290f24b3dc2f71872fb8193824d00f02c8f99d67ed4710fc83ace5a396abf
+  metadata.gz: 93692404a440374e0b958222b3ee13dac1d1e54822c3fb119e3fdfc1af328a644aef58cc5f4f92dcf3ee20820c17f773504f4d3ed44f91e7982ab5033829984c
+  data.tar.gz: 73a58d81336dc139c41c1c50e55d90c59a7cadd3016864cfc5affd96766241940e203efb24b1b9cb6d79608997f0492d80be4ffa501bc02242b25c18d5dcd809

data/docs/index.asciidoc

@@ -83,6 +83,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-update>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-uppercase>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-capitalize>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-tag_on_failure>> |<<string,string>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -372,5 +373,14 @@ Example:
       }
     }
 
+[id="plugins-{type}s-{plugin}-tag_on_failure"]
+===== `tag_on_failure`
+
+  * Value type is <<string,string>>
+  * The default value for this setting is `_mutate_error`
+
+If a failure occurs during the application of this mutate filter, the rest of
+the operations are aborted and the provided tag is added to the event.
+
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/mutate.rb

@@ -207,6 +207,9 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   #     }
   config :copy, :validate => :hash
 
+  # Tag to apply if the operation errors
+  config :tag_on_failure, :validate => :string, :default => '_mutate_error'
+
   TRUE_REGEX = (/^(true|t|yes|y|1|1.0)$/i).freeze
   FALSE_REGEX = (/^(false|f|no|n|0|0.0)$/i).freeze
   CONVERT_PREFIX = "convert_".freeze
@@ -262,6 +265,11 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
     copy(event) if @copy
 
     filter_matched(event)
+  rescue => ex
+    meta = { :exception => ex.message }
+    meta[:backtrace] = ex.backtrace if logger.debug?
+    logger.warn('Exception caught while applying mutate filter', meta)
+    event.tag(@tag_on_failure)
   end
 
   private

data/logstash-filter-mutate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '3.4.0'
+  s.version         = '3.5.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Performs mutations on fields"
   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"

data/spec/filters/mutate_spec.rb

@@ -23,6 +23,56 @@ module LogStash::Environment
   end
 end
 
+logstash_version = Gem::Version.create(LOGSTASH_CORE_VERSION)
+
+if (Gem::Requirement.create('~> 7.0').satisfied_by?(logstash_version) ||
+   (Gem::Requirement.create('~> 6.4').satisfied_by?(logstash_version) && LogStash::SETTINGS.get('config.field_reference.parser') == 'STRICT'))
+  describe LogStash::Filters::Mutate do
+    let(:config) { Hash.new }
+    subject(:mutate_filter) { LogStash::Filters::Mutate.new(config) }
+
+    before(:each) { mutate_filter.register }
+
+    let(:event) { LogStash::Event.new(attrs) }
+
+    context 'when operation would cause an error' do
+
+      let(:invalid_field_name) { "[[][[[[]message" }
+      let(:config) do
+        super().merge("add_field" => {invalid_field_name => "nope"})
+      end
+
+      shared_examples('catch and tag error') do
+        let(:expected_tag) { '_mutate_error' }
+
+        let(:event) { LogStash::Event.new({"message" => "foo"})}
+
+        context 'when the event is filtered' do
+          before(:each) { mutate_filter.filter(event) }
+          it 'does not raise an exception' do
+            # noop
+          end
+
+          it 'tags the event with the expected tag' do
+            expect(event).to include('tags')
+            expect(event.get('tags')).to include(expected_tag)
+          end
+        end
+      end
+
+      context 'when `tag_on_failure` is not provided' do
+        include_examples 'catch and tag error'
+      end
+
+      context 'when `tag_on_failure` is provided' do
+        include_examples 'catch and tag error' do
+          let(:expected_tag) { 'my_custom_tag' }
+          let(:config) { super().merge('tag_on_failure' => expected_tag) }
+        end
+      end
+    end
+  end
+end
 
 describe LogStash::Filters::Mutate do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement