logstash-filter-truncate 1.0.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7cf39e6a114d7a4009db9ecd95141f257ebe0b07
-  data.tar.gz: e52131367130d3af6a7ebf1e7922015a989047c6
+SHA256:
+  metadata.gz: d6cee506384ca74446e793c26835a97e3ba9bd723336fb545805a89730f697cc
+  data.tar.gz: d404c16127216d316028bbd8adda4d3ebd92f99ff43de3eaaa9b05b5ed0336b5
 SHA512:
-  metadata.gz: 250aea4f5f329c99e402d9a9dc787e89dc2d89ce6aab956a028de67cb7e9420873f41a465b0cf01d9847c8f77cd5a02ecbea3985e04c9eb3f47f2fed059fe31c
-  data.tar.gz: 1c817cec96009a69ba17c787da917cc15778b32dcacfb87665cc6dd36d54940271854bee4ee252da6f8d6a1539ad64b22e7546c2c11f633bef2bd74919e339b5
+  metadata.gz: 52417db9d6676f2c497386053aaa1bea1151f1122b0ebdf02437ef4d8bc7f057e84038d5d7b740ecf10d7f30715fb5fad56e4b4e7047e5b005a84394e6ed070f
+  data.tar.gz: ace5c1afff45aed940cb4a4e774924d2bfc25b17460a07449550057c242335fce3baee8691f070c43d017ac4a4d3de58778d585253c7460daa42f7a8966e539b

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.0.5
+  - Switches behavior of add_tag and add_field, now tags and fields are added only when the truncation happens 
+    on any field or nested field [#7](https://github.com/logstash-plugins/logstash-filter-truncate/pull/7).
+    
+## 1.0.4
+  - Update gemspec summary
+
+## 1.0.3
+  - Fix some documentation issues
+
 ## 1.0.1
   - Method filter_matched wasn't being called after truncate #2
 

data/LICENSE

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

data/docs/index.asciidoc

@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="plugins-{type}-{plugin}"]
+[id="plugins-{type}s-{plugin}"]
 
 === Truncate filter plugin
 

data/lib/logstash/filters/truncate.rb

@@ -40,13 +40,19 @@ class LogStash::Filters::Truncate < LogStash::Filters::Base
 
   def filter(event)
     if @fields
-      @fields.each do |field|
-        Truncator.truncate(event, field, @length_bytes)
-      end
+      truncated = Truncator.truncate_all(fields, event, @length_bytes)
     else
-      Truncator.truncate_all(event, @length_bytes)
+      # TODO(sissel): I couldn't find a better way to get the top level keys for
+      # an event. Nor could I find a way to iterate over all the keys in an
+      # event, so this may have to suffice.
+      fields = event.to_hash.keys.map { |k| "[#{k}]" }
+      truncated = Truncator.truncate_all(fields, event, @length_bytes)
     end
-    filter_matched(event)
+    
+    if truncated
+      @logger.debug("truncated one or more fields from event to length #{@length_bytes}")
+      filter_matched(event)
+    end  
   end
 
   module Truncator
@@ -79,18 +85,23 @@ class LogStash::Filters::Truncate < LogStash::Filters::Base
       return v
     end
 
-    def truncate_all(event, length)
-      # TODO(sissel): I couldn't find a better way to get the top level keys for
-      # an event. Nor could I find a way to iterate over all the keys in an
-      # event, so this may have to suffice.
-      fields = event.to_hash.keys.map { |k| "[#{k}]" }
+    def truncate_all(fields, event, length)
+      truncated = false
+
       fields.each do |field|
+        before = event.get(field)
         truncate(event, field, length)
+        after = event.get(field)
+
+        truncated ||= (before != after)
       end
+
+      truncated
     end
 
     def truncate(event, field, length)
       value = event.get(field)
+
       if value.is_a?(String)
         event.set(field, trim(value, length))
       elsif value.is_a?(Array)

data/logstash-filter-truncate.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-truncate'
-  s.version         = '1.0.2'
+  s.version         = '1.0.5'
   s.licenses        = ['Apache License (2.0)']
-  s.summary         = "This filter allows you to truncate fields to a given length."
+  s.summary         = "Truncates fields longer than a given length"
   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"]
   s.email           = 'info@elastic.co'

data/spec/filters/truncate_spec.rb

@@ -13,24 +13,76 @@ end
 describe LogStash::Filters::Truncate do
   analyze_results
 
-  context "defaults" do
-    let(:data) {
-      {
-        "foo" => { "bar" => Flores::Random.text(0..1000) },
-        "one" => { "two" => { "three" => Flores::Random.text(0..1000) } },
-        "baz" => Flores::Random.text(0..1000),
+  context "with hash fields" do
+    context "stress test" do
+      let(:data) {
+        {
+          "foo" => { "bar" => Flores::Random.text(0..1000) },
+          "one" => { "two" => { "three" => Flores::Random.text(0..1000) } },
+          "baz" => Flores::Random.text(0..1000),
+        }
       }
-    }
-    let(:length) { Flores::Random.integer(0..1000) }
-    subject { described_class.new("length_bytes" => length) }
-    let(:event) { LogStash::Event.new(data) }
+      let(:length) { Flores::Random.integer(0..1000) }
+      subject { described_class.new("length_bytes" => length) }
+      let(:event) { LogStash::Event.new(data) }
+
+      before { subject.filter(event) }
+
+      stress_it "should truncate all strings in the hash" do
+        expect(event.get("[foo][bar]").bytesize).to be <= length
+        expect(event.get("[one][two][three]").bytesize).to be <= length
+        expect(event.get("baz").bytesize).to be <= length
+      end
+    end
+
+    context "unit test" do
 
-    before { subject.filter(event) }
+      let(:length) { 450 }
+      subject { described_class.new("length_bytes" => length) }
+      let(:event) { LogStash::Event.new(data) }
 
-    stress_it "should truncate all strings in the hash" do
-      expect(event.get("[foo][bar]").bytesize).to be <= length
-      expect(event.get("[one][two][three]").bytesize).to be <= length
-      expect(event.get("baz").bytesize).to be <= length
+      context "fields exceeding length" do
+        let(:data) {
+          {
+            "foo" => { "bar" => "a" * 500 },
+            "one" => { "two" => { "three" => "b" * 600 } },
+            "baz" => "c" * 700,
+          }
+        }
+
+        it "should truncate all strings in the hash" do
+          expect(subject).to receive(:filter_matched).once
+
+          subject.filter(event)
+
+          expect(event.get("[foo][bar]").bytesize).to be <= length
+          expect(event.get("[one][two][three]").bytesize).to be <= length
+          expect(event.get("baz").bytesize).to be <= length
+        end
+      end
+
+      context "fields not exceeding length" do
+        let(:data) {
+          {
+            "foo" => { "bar" =>"a" * 350 },
+            "one" => { "two" => { "three" => "b" * 300 } },
+            "baz" => "c" * 450,
+          }
+        }
+
+        it "shouldn't truncate strings in the hash" do
+          expect(subject).not_to receive(:filter_matched)
+          foo_bar_prev = event.get("[foo][bar]").bytesize
+          one_two_three_prev = event.get("[one][two][three]").bytesize
+          baz_prev = event.get("baz").bytesize
+
+          subject.filter(event)
+
+          expect(event.get("[foo][bar]").bytesize).to eq foo_bar_prev
+          expect(event.get("[one][two][three]").bytesize).to eq one_two_three_prev
+          expect(event.get("baz").bytesize).to eq baz_prev
+        end
+      end
     end
   end
 
@@ -64,8 +116,9 @@ describe LogStash::Filters::Truncate do
     let(:event) { LogStash::Event.new("example" => number) }
 
 
-    it "should do nothing" do
+    stress_it "should do nothing" do
       expect(event.get("example")).to be == number
+      expect(subject).not_to receive(:filter_matched)
     end
   end
 
@@ -76,22 +129,44 @@ describe LogStash::Filters::Truncate do
     subject { described_class.new("length_bytes" => length, "fields" => [ "example" ]) }
     let(:event) { LogStash::Event.new("example" => list) }
 
-    before { subject.filter(event) }
+    context "stress test" do
+      before { subject.filter(event) }
 
-    stress_it "should truncate all elements in a list" do
-      count.times do |i| 
-        expect(event.get("[example][#{i}]").bytesize).to be <= length
+      stress_it "should truncate all elements in a list" do
+        count.times do |i|
+          expect(event.get("[example][#{i}]").bytesize).to be <= length
+        end
       end
     end
-  end
 
-  describe "calling of filter_matched" do
-    subject { described_class.new("length_bytes" => 1, "fields" => [ "example" ]) }
-    let(:event) { LogStash::Event.new("example" => 1000) }
+    context "containing elements greater than size" do
+      let(:count) { 10 }
+      let(:list) { count.times.map { "a" * 100 } }
+      let(:length) { 50 }
 
-    it "should be called" do
-      expect(subject).to receive(:filter_matched).once
-      subject.filter(event)
+      it "should truncate all elements" do
+        expect(subject).to receive(:filter_matched).once
+
+        subject.filter(event)
+
+        count.times do |i|
+          expect(event.get("[example][#{i}]").bytesize).to be <= length
+        end
+      end
+    end
+
+    context "containing elements with mixed sizes" do
+      let(:count) { 10 }
+      let(:list) { (count - 1).times.map { "a" * 20 } + ["b" * 100]}
+      let(:length) { 50 }
+
+      it "should truncate elements that exceed the length" do
+        expect(subject).to receive(:filter_matched).once
+
+        subject.filter(event)
+
+        expect(event.get("[example][#{count - 1}]").bytesize).to be <= length
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-truncate
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +58,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.7
-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: []
@@ -95,10 +97,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: This filter allows you to truncate fields to a given length.
+summary: Truncates fields longer than a given length
 test_files:
 - spec/filters/truncate_spec.rb