logstash-filter-de_dot 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cf3cf1e8afcb7d2c7576c2ae37bfb2b4d7023f44abb343e74665662a9c03d06
-  data.tar.gz: c506771dbdf8c88e83e6bcf4dd281512faebf37d79c9fc92dbea6e8f32e3a569
+  metadata.gz: 98352a8a3f114890d7b9dc1cd76dbc529db11911c9c227b7f184d1b6a32ba0b4
+  data.tar.gz: 6afa026b74f730c0c5e8f14ff055ef6605343818420ef4cf612064d31f82be38
 SHA512:
-  metadata.gz: 7c6b8d0446ed1bdcc02498054bff807e95faa7658cb58d79f82c1b37fb28c073de0a9092b2e79c808176c7b365477490fd52a295c561194cdeff3f49985b8b87
-  data.tar.gz: fdbf76bf8f5205eb47e0c173c5ee5c35ebfc4a9e4a3da286e924facdeb8b11967258ce9ed95b60b3dc7c0704ba2de6ebea97e8c18c0ace264e87fe33451f7e3a
+  metadata.gz: 754076d22371d5d766e8324f4acfd08ebb9e60704086cddc60d9cc0010b2d0dc8d0489f86c23c6da6a53e58b7f0d0414b29703364b8c62568e94130a2366541d
+  data.tar.gz: b11ef0eddcb8f76dc3ffac24eaf92ab4f591e2eb23ceaf1b181ce0006b1ffd81568734afe95efab18871e120c271ca8c6ce617d318596d68f2143b8f11e3011a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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)
+
+## 1.0.4
+  - fix failure of fieldnames with boolean value "false" #9
+
 ## 1.0.3
   - Update gemspec summary
 

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
-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 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-de_dot.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-de_dot)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-de_dot.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-de_dot)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -37,6 +37,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-nested>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-recursive>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-separator>> |<<string,string>>|No
 |=======================================================================
 
@@ -58,7 +59,6 @@ will result in "field_suffix" and nested or sub field ["foo"]["bar_suffix"]
 
 WARNING: This is an expensive operation.
 
-
 [id="plugins-{type}s-{plugin}-nested"]
 ===== `nested` 
 
@@ -68,6 +68,15 @@ WARNING: This is an expensive operation.
 If `nested` is _true_, then create sub-fields instead of replacing dots with
 a different separator.
 
+[id="plugins-{type}s-{plugin}-recursive"]
+===== `recursive`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If `recursive` is _true_, then recursively check sub-fields. It is recommended you
+only use this when setting specific fields, as this is an expensive operation.
+
 [id="plugins-{type}s-{plugin}-separator"]
 ===== `separator` 
 

data/lib/logstash/filters/de_dot.rb

@@ -19,11 +19,17 @@ class LogStash::Filters::De_dot < LogStash::Filters::Base
   # a different separator.
   config :nested, :validate => :boolean, :default => false
 
+  # If `recursive` is _true_, then recursively check sub-fields. It is recommended you
+  # only use this when specifying specific fields.
+  config :recursive, :validate => :boolean, :default => false
+
   # The `fields` array should contain a list of known fields to act on.
   # If undefined, all top-level fields will be checked.  Sub-fields must be
   # manually specified in the array.  For example: `["field.suffix","[foo][bar.suffix]"]`
   # will result in "field_suffix" and nested or sub field ["foo"]["bar_suffix"]
   #
+  # To check all sub-fields, enable recursive checking.
+  #
   # WARNING: This is an expensive operation.
   #
   config :fields, :validate => :array
@@ -61,20 +67,34 @@ class LogStash::Filters::De_dot < LogStash::Filters::Base
 
   private
   def rename_field(event, fieldref)
-    @logger.debug? && @logger.debug("de_dot: preprocess", :event => event.to_hash.to_s)
-    if @separator == ']['
+    if @separator == '][' || @recursive
       @logger.debug? && @logger.debug("de_dot: fieldref pre-process", :fieldref => fieldref)
       fieldref = '[' + fieldref if fieldref[0] != '['
       fieldref = fieldref + ']' if fieldref[-1] != ']'
       @logger.debug? && @logger.debug("de_dot: fieldref bounding square brackets should exist now", :fieldref => fieldref)
     end
-    @logger.debug? && @logger.debug("de_dot: source field reference", :fieldref => fieldref)
-    newref = fieldref.gsub('.', @separator)
-    @logger.debug? && @logger.debug("de_dot: replacement field reference", :newref => newref)
-    event.set(newref, event.get(fieldref))
-    @logger.debug? && @logger.debug("de_dot: event with both new and old field references", :event => event.to_hash.to_s)
-    event.remove(find_fieldref_for_delete(fieldref))
-    @logger.debug? && @logger.debug("de_dot: postprocess", :event => event.to_hash.to_s)
+
+    if has_dot?(fieldref)
+      @logger.debug? && @logger.debug("de_dot: preprocess", :event => event.to_hash.to_s)
+      @logger.debug? && @logger.debug("de_dot: source field reference", :fieldref => fieldref)
+      newref = fieldref.gsub('.', @separator)
+      @logger.debug? && @logger.debug("de_dot: replacement field reference", :newref => newref)
+      event.set(newref, event.get(fieldref))
+      @logger.debug? && @logger.debug("de_dot: event with both new and old field references", :event => event.to_hash.to_s)
+      event.remove(find_fieldref_for_delete(fieldref))
+      @logger.debug? && @logger.debug("de_dot: postprocess", :event => event.to_hash.to_s)
+      fieldref = newref
+    end
+
+    if @recursive
+      @logger.debug? && @logger.debug("de_dot: recursively process field reference", :fieldref => fieldref)
+      content = event.get(fieldref)
+      if content.is_a?(Hash)
+        content.keys.each do |ref|
+          rename_field(event, "#{fieldref}[#{ref}]")
+        end
+      end
+    end
   end
 
   public
@@ -88,8 +108,8 @@ class LogStash::Filters::De_dot < LogStash::Filters::Base
     end
     @logger.debug? && @logger.debug("de_dot: Act on these fields", :fields => fields)
     fields.each do |ref|
-      if event.get(ref)
-        rename_field(event, ref) if has_dot?(ref)
+      if event.include?(ref)
+        rename_field(event, ref) if has_dot?(ref) || @recursive
       end
     end
     filter_matched(event)

data/logstash-filter-de_dot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-de_dot'
-  s.version         = '1.0.3'
+  s.version         = '1.1.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

@@ -178,7 +178,7 @@ describe LogStash::Filters::De_dot do
     it "should replace all dots with underscores" do
       subject.filter(event)
       expect(event.get('acme')).not_to include('super.roller_skates')
-      expect(event.get('[acme][super_roller_skates')).to eq('coyote')
+      expect(event.get('[acme][super_roller_skates]')).to eq('coyote')
     end
 
     it "should not change a field without dots" do
@@ -205,7 +205,7 @@ describe LogStash::Filters::De_dot do
     it "should replace all dots with underscores" do
       subject.filter(event)
       expect(event.get('acme')).not_to include('super.roller_skates')
-      expect(event.get('[acme][super][roller_skates')).to eq('coyote')
+      expect(event.get('[acme][super][roller_skates]')).to eq('coyote')
     end
 
     it "should not change a field without dots" do
@@ -215,4 +215,118 @@ describe LogStash::Filters::De_dot do
     end
   end
 
+  describe "Field values containing false" do
+    let(:config) {
+      {
+        "nested" => true,
+      }
+    }
+    let(:attrs) {
+      {
+        "coyote.won" => false
+      }
+    }
+
+    it "should not be ignored" do
+      subject.filter(event)
+      expect(event).not_to include('coyote.won')
+      expect(event.get('[coyote][won]')).to be false
+    end
+  end
+
+  describe "Recursive processing" do
+    let(:config) { { "recursive" => true } }
+    let(:attrs) { { "acme" => { "roller.skates" => "coyote", "nodot" => "nochange" } } }
+
+    it "should replace dots in sub-fields to underscores" do
+      subject.filter(event)
+      expect(event.to_hash['acme'].keys).not_to include('roller.skates')
+      expect(event.get('[acme][roller_skates]')).to eq('coyote')
+    end
+
+    it "should not change a field without dots" do
+      subject.filter(event)
+      expect(event.to_hash['acme'].keys).to include('nodot')
+      expect(event.get('[acme][nodot]')).to eq('nochange')
+    end
+
+    context "with nested fields" do
+      let(:config) { { "recursive" => true, "nested" => true } }
+      let(:attrs) { { "acme" => { "roller.skates" => "coyote", "nodot" => "nochange" } } }
+
+      it "should convert dotted sub-fields to nested sub-fields" do
+        subject.filter(event)
+        expect(event.to_hash['acme'].keys).not_to include('roller.skates')
+        expect(event.get('[acme][roller][skates]')).to eq('coyote')
+      end
+
+      it "should not change a field without dots" do
+        subject.filter(event)
+        expect(event.to_hash['acme'].keys).to include('nodot')
+        expect(event.get('[acme][nodot]')).to eq('nochange')
+      end
+    end
+
+    context "with deeply nested fields" do
+      let(:config) { { "recursive" => true, "nested" => true } }
+      let(:attrs) { { "acme" => { "super.duper" => { "roller.skates" => "coyote", "nodot" => "nochange" } } } }
+
+      it "should convert dotted sub-fields to nested sub-fields" do
+        subject.filter(event)
+        expect(event.to_hash['acme'].keys).not_to include('super.duper')
+        expect(event.get('[acme][super][duper]').keys).not_to include('roller.skates')
+        expect(event.get('[acme][super][duper][roller][skates]')).to eq('coyote')
+      end
+
+      it "should not change a field without dots" do
+        subject.filter(event)
+        expect(event.get('[acme][super][duper]').keys).to include('nodot')
+        expect(event.get('[acme][super][duper][nodot]')).to eq('nochange')
+      end
+    end
+
+    context "with specific nested fields" do
+      let(:config) { { "recursive" => true, "nested" => true, "fields" => [ "acme" ] } }
+      let(:attrs) { { "acme" => { "roller.skates" => "coyote" }, "foo.bar" => "nochange" } }
+
+      it "should convert dotted sub-fields to nested sub-fields within specified fields" do
+        subject.filter(event)
+        expect(event.to_hash['acme'].keys).not_to include('roller.skates')
+        expect(event.get('[acme][roller][skates]')).to eq('coyote')
+      end
+
+      it "should not change a field not listed, even with dots" do
+        subject.filter(event)
+        expect(event.to_hash.keys).to include('foo.bar')
+        expect(event.get('foo.bar')).to eq('nochange')
+      end
+    end
+
+    context "with multiple specific nested fields" do
+      let(:config) {
+        {
+            "recursive" => true,
+            "nested" => true,
+            "fields" => [ "acme", "foo.bar", "a.b" ]
+        }
+      }
+      let(:attrs) {
+        {
+            "acme" => { "roller.skates" => "coyote" },
+            "foo.bar" => "nochange",
+            "a.b" => { "c.d" => { "e.f" => "finally"} }
+        }
+      }
+
+      it "should convert all dotted fields to sub-fields within specified fields" do
+        subject.filter(event)
+        expect(event.get('acme')).not_to include('roller.skates')
+        expect(event.get('[acme][roller][skates]')).to eq('coyote')
+        expect(event.to_hash.keys).not_to include('foo.bar')
+        expect(event.get('[foo][bar]')).to eq('nochange')
+        expect(event.to_hash.keys).not_to include('a.b')
+        expect(event.get('[a][b][c][d][e][f]')).to eq('finally')
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-de_dot
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -85,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Computationally expensive filter that removes dots from a field name