logstash-filter-de_dot 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98352a8a3f114890d7b9dc1cd76dbc529db11911c9c227b7f184d1b6a32ba0b4
-  data.tar.gz: 6afa026b74f730c0c5e8f14ff055ef6605343818420ef4cf612064d31f82be38
+  metadata.gz: e61d500f4e4c6529f93e1637c5f8d882e687426b8b41045c35df11495fd13a86
+  data.tar.gz: 912cd01e0908f96a387862001411d365e78b052528cdb720df472434e931f150
 SHA512:
-  metadata.gz: 754076d22371d5d766e8324f4acfd08ebb9e60704086cddc60d9cc0010b2d0dc8d0489f86c23c6da6a53e58b7f0d0414b29703364b8c62568e94130a2366541d
-  data.tar.gz: b11ef0eddcb8f76dc3ffac24eaf92ab4f591e2eb23ceaf1b181ce0006b1ffd81568734afe95efab18871e120c271ca8c6ce617d318596d68f2143b8f11e3011a
+  metadata.gz: 8596d82db2eacefe60272da399c688e95c8741fcb5ed22952a2ea33fb1a4c3bf862ccc3c977428c4c2f190e08b51662efb69e43f5a489ad6c396450a91a13c0c
+  data.tar.gz: 103d4b998e51b00bb1972861549447d677ede174165334eedcf4ada54c4ed625a0a1dcf6a1bf2c0591a989a9f5dc9304b3b85f12cc670a1a94a3bcf7a3aa6e1b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.2.0
+  - Add support to tag on failures when de_dot filter encounter a problem during the processing of the event [#26](https://github.com/logstash-plugins/logstash-filter-de_dot/pull/26)
+
 ## 1.1.0
   - Add support for recursively searching sub-fields with the new `recusive =>` config option [#24](https://github.com/logstash-plugins/logstash-filter-de_dot/pull/24)
 

data/docs/index.asciidoc

@@ -39,6 +39,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-nested>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-recursive>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-separator>> |<<string,string>>|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
@@ -85,6 +86,14 @@ only use this when setting specific fields, as this is an expensive operation.
 
 Replace dots with this value.
 
+[id="plugins-{type}s-{plugin}-tag_on_failure"]
+===== `tag_on_failure`
+
+  * Value type is <<string,string>>
+  * The default value for this setting is `_de_dot_error`
+
+If a failure occurs during the application of this de_dot filter, the provided tag is added to the event.
+
 
 
 [id="plugins-{type}s-{plugin}-common-options"]

data/lib/logstash/filters/de_dot.rb

@@ -34,6 +34,9 @@ class LogStash::Filters::De_dot < LogStash::Filters::Base
   #
   config :fields, :validate => :array
 
+  # Tag to apply if the operation errors
+  config :tag_on_failure, :validate => :string, :default => '_de_dot_error'
+
   public
   def has_dot?(fieldref)
     fieldref =~ /\./
@@ -113,5 +116,10 @@ class LogStash::Filters::De_dot < LogStash::Filters::Base
       end
     end
     filter_matched(event)
+  rescue => ex
+    meta = { :exception => ex.message }
+    meta[:backtrace] = ex.backtrace if logger.debug?
+    logger.warn('Exception caught while applying de_dot filter', meta)
+    event.tag(@tag_on_failure)
   end # def filter
 end # class LogStash::Filters::De_dot

data/logstash-filter-de_dot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-de_dot'
-  s.version         = '1.1.0'
+  s.version         = '1.2.0'
   s.licenses = ['Apache License (2.0)']
   s.summary = "Computationally expensive filter that removes dots from a field name"
   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/de_dot_spec.rb

@@ -88,6 +88,35 @@ describe LogStash::Filters::De_dot do
       expect(event.to_hash.keys).to include('nodot')
       expect(event.get('nodot')).to eq('nochange')
     end
+    
+    context "when nested fields overlaps scalar fields" do
+      let(:config) { { "nested" => true } }
+      let(:attrs) { { "request" => "GET", "request.path" => "/users" } }
+
+      shared_examples('catch and tag error') do
+        let(:expected_tag) { '_de_dot_error' }
+
+        context 'when the event is filtered' do
+          before(:each) { subject.filter(event) }
+
+          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_error" }
+          let(:config) { super().merge("tag_on_failure" => expected_tag) }
+        end
+      end
+    end
   end
 
   describe "Specific nested field" do

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-de_dot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Elastic
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2026-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -19,9 +19,8 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
-  name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,14 +30,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
+  name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,7 +69,6 @@ licenses:
 metadata:
   logstash_plugin: 'true'
   logstash_group: filter
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Computationally expensive filter that removes dots from a field name
 test_files: