logstash-filter-truncate 1.0.4 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eb515591ec060aeec195a68ae1553c512365d1ab6d551962fe92b8dcd3773f39
4
- data.tar.gz: 68214a7c8853fb5cbe9ef86a14f95d02e1d2d0e43ce79a215e1ff201e84f56f7
3
+ metadata.gz: 500f6a7318339fca85021c1f2510b7ded8bef040601e23ebc2cdda29d3fcf78a
4
+ data.tar.gz: f751cd203fbf21c1f91d928f5f6ad53c60c2d3c6b544cd7c6ca6261318e9a416
5
5
  SHA512:
6
- metadata.gz: 8d87b668a6b19c1678593eeb658fc764fd41a8da30e92c384643cf8199faaa9465678de8afee890295c33e6fc7070f202558a7c83b4b5f0f624ac9fc024eb07e
7
- data.tar.gz: 942c32699000fb1232b07d3b1b60203a8baa14bad3213a8740d9639e3f857f082707363f0a71c940e3ef28288b7c11aee5f40a7b1aef1336f35709b2db2904d4
6
+ metadata.gz: 5387e09614e3dfe2cfbf4890bee0858e015885f931d82bbdf40abd2a8f14cb13d03a495cb33f7923fc28dace9c36fb836a04e4aa04d2f97bfd31a74b5d7245ab
7
+ data.tar.gz: 8a6bf346d9dfc4fec1560405930cf9971671d79bbf7e2d2fadad698dff34fe8144029ddb5bd52e8b9a80bf744fc694d29d3ab77b3d26164ed3273ab1ffaab02e
data/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ ## 1.0.6
2
+ - Make 0.0.8 the lower bound for flores dependency [#9](https://github.com/logstash-plugins/logstash-filter-truncate/pull/9)
3
+
4
+ ## 1.0.5
5
+ - Switches behavior of add_tag and add_field, now tags and fields are added only when the truncation happens
6
+ on any field or nested field [#7](https://github.com/logstash-plugins/logstash-filter-truncate/pull/7).
7
+
1
8
  ## 1.0.4
2
9
  - Update gemspec summary
3
10
 
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2016 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2020 Elastic and contributors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Logstash Plugin
2
2
 
3
- [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-truncate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-truncate)
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-truncate.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-truncate)
4
4
 
5
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
6
 
@@ -40,13 +40,19 @@ class LogStash::Filters::Truncate < LogStash::Filters::Base
40
40
 
41
41
  def filter(event)
42
42
  if @fields
43
- @fields.each do |field|
44
- Truncator.truncate(event, field, @length_bytes)
45
- end
43
+ truncated = Truncator.truncate_all(fields, event, @length_bytes)
46
44
  else
47
- Truncator.truncate_all(event, @length_bytes)
45
+ # TODO(sissel): I couldn't find a better way to get the top level keys for
46
+ # an event. Nor could I find a way to iterate over all the keys in an
47
+ # event, so this may have to suffice.
48
+ fields = event.to_hash.keys.map { |k| "[#{k}]" }
49
+ truncated = Truncator.truncate_all(fields, event, @length_bytes)
48
50
  end
49
- filter_matched(event)
51
+
52
+ if truncated
53
+ @logger.debug("truncated one or more fields from event to length #{@length_bytes}")
54
+ filter_matched(event)
55
+ end
50
56
  end
51
57
 
52
58
  module Truncator
@@ -79,18 +85,23 @@ class LogStash::Filters::Truncate < LogStash::Filters::Base
79
85
  return v
80
86
  end
81
87
 
82
- def truncate_all(event, length)
83
- # TODO(sissel): I couldn't find a better way to get the top level keys for
84
- # an event. Nor could I find a way to iterate over all the keys in an
85
- # event, so this may have to suffice.
86
- fields = event.to_hash.keys.map { |k| "[#{k}]" }
88
+ def truncate_all(fields, event, length)
89
+ truncated = false
90
+
87
91
  fields.each do |field|
92
+ before = event.get(field)
88
93
  truncate(event, field, length)
94
+ after = event.get(field)
95
+
96
+ truncated ||= (before != after)
89
97
  end
98
+
99
+ truncated
90
100
  end
91
101
 
92
102
  def truncate(event, field, length)
93
103
  value = event.get(field)
104
+
94
105
  if value.is_a?(String)
95
106
  event.set(field, trim(value, length))
96
107
  elsif value.is_a?(Array)
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-filter-truncate'
4
- s.version = '1.0.4'
4
+ s.version = '1.0.6'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "Truncates fields longer than a given length"
7
7
  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"
@@ -22,5 +22,5 @@ Gem::Specification.new do |s|
22
22
  # Gem dependencies
23
23
  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
24
24
  s.add_development_dependency "logstash-devutils"
25
- s.add_development_dependency "flores", "~> 0.0.7"
25
+ s.add_development_dependency "flores", "~> 0.0.8"
26
26
  end
@@ -13,24 +13,76 @@ end
13
13
  describe LogStash::Filters::Truncate do
14
14
  analyze_results
15
15
 
16
- context "defaults" do
17
- let(:data) {
18
- {
19
- "foo" => { "bar" => Flores::Random.text(0..1000) },
20
- "one" => { "two" => { "three" => Flores::Random.text(0..1000) } },
21
- "baz" => Flores::Random.text(0..1000),
16
+ context "with hash fields" do
17
+ context "stress test" do
18
+ let(:data) {
19
+ {
20
+ "foo" => { "bar" => Flores::Random.text(0..1000) },
21
+ "one" => { "two" => { "three" => Flores::Random.text(0..1000) } },
22
+ "baz" => Flores::Random.text(0..1000),
23
+ }
22
24
  }
23
- }
24
- let(:length) { Flores::Random.integer(0..1000) }
25
- subject { described_class.new("length_bytes" => length) }
26
- let(:event) { LogStash::Event.new(data) }
25
+ let(:length) { Flores::Random.integer(0..1000) }
26
+ subject { described_class.new("length_bytes" => length) }
27
+ let(:event) { LogStash::Event.new(data) }
28
+
29
+ before { subject.filter(event) }
30
+
31
+ stress_it "should truncate all strings in the hash" do
32
+ expect(event.get("[foo][bar]").bytesize).to be <= length
33
+ expect(event.get("[one][two][three]").bytesize).to be <= length
34
+ expect(event.get("baz").bytesize).to be <= length
35
+ end
36
+ end
37
+
38
+ context "unit test" do
27
39
 
28
- before { subject.filter(event) }
40
+ let(:length) { 450 }
41
+ subject { described_class.new("length_bytes" => length) }
42
+ let(:event) { LogStash::Event.new(data) }
29
43
 
30
- stress_it "should truncate all strings in the hash" do
31
- expect(event.get("[foo][bar]").bytesize).to be <= length
32
- expect(event.get("[one][two][three]").bytesize).to be <= length
33
- expect(event.get("baz").bytesize).to be <= length
44
+ context "fields exceeding length" do
45
+ let(:data) {
46
+ {
47
+ "foo" => { "bar" => "a" * 500 },
48
+ "one" => { "two" => { "three" => "b" * 600 } },
49
+ "baz" => "c" * 700,
50
+ }
51
+ }
52
+
53
+ it "should truncate all strings in the hash" do
54
+ expect(subject).to receive(:filter_matched).once
55
+
56
+ subject.filter(event)
57
+
58
+ expect(event.get("[foo][bar]").bytesize).to be <= length
59
+ expect(event.get("[one][two][three]").bytesize).to be <= length
60
+ expect(event.get("baz").bytesize).to be <= length
61
+ end
62
+ end
63
+
64
+ context "fields not exceeding length" do
65
+ let(:data) {
66
+ {
67
+ "foo" => { "bar" =>"a" * 350 },
68
+ "one" => { "two" => { "three" => "b" * 300 } },
69
+ "baz" => "c" * 450,
70
+ }
71
+ }
72
+
73
+ it "shouldn't truncate strings in the hash" do
74
+ expect(subject).not_to receive(:filter_matched)
75
+ foo_bar_prev = event.get("[foo][bar]").bytesize
76
+ one_two_three_prev = event.get("[one][two][three]").bytesize
77
+ baz_prev = event.get("baz").bytesize
78
+
79
+ subject.filter(event)
80
+
81
+ expect(event.get("[foo][bar]").bytesize).to eq foo_bar_prev
82
+ expect(event.get("[one][two][three]").bytesize).to eq one_two_three_prev
83
+ expect(event.get("baz").bytesize).to eq baz_prev
84
+ end
85
+ end
34
86
  end
35
87
  end
36
88
 
@@ -64,8 +116,9 @@ describe LogStash::Filters::Truncate do
64
116
  let(:event) { LogStash::Event.new("example" => number) }
65
117
 
66
118
 
67
- it "should do nothing" do
119
+ stress_it "should do nothing" do
68
120
  expect(event.get("example")).to be == number
121
+ expect(subject).not_to receive(:filter_matched)
69
122
  end
70
123
  end
71
124
 
@@ -76,22 +129,44 @@ describe LogStash::Filters::Truncate do
76
129
  subject { described_class.new("length_bytes" => length, "fields" => [ "example" ]) }
77
130
  let(:event) { LogStash::Event.new("example" => list) }
78
131
 
79
- before { subject.filter(event) }
132
+ context "stress test" do
133
+ before { subject.filter(event) }
80
134
 
81
- stress_it "should truncate all elements in a list" do
82
- count.times do |i|
83
- expect(event.get("[example][#{i}]").bytesize).to be <= length
135
+ stress_it "should truncate all elements in a list" do
136
+ count.times do |i|
137
+ expect(event.get("[example][#{i}]").bytesize).to be <= length
138
+ end
84
139
  end
85
140
  end
86
- end
87
141
 
88
- describe "calling of filter_matched" do
89
- subject { described_class.new("length_bytes" => 1, "fields" => [ "example" ]) }
90
- let(:event) { LogStash::Event.new("example" => 1000) }
142
+ context "containing elements greater than size" do
143
+ let(:count) { 10 }
144
+ let(:list) { count.times.map { "a" * 100 } }
145
+ let(:length) { 50 }
91
146
 
92
- it "should be called" do
93
- expect(subject).to receive(:filter_matched).once
94
- subject.filter(event)
147
+ it "should truncate all elements" do
148
+ expect(subject).to receive(:filter_matched).once
149
+
150
+ subject.filter(event)
151
+
152
+ count.times do |i|
153
+ expect(event.get("[example][#{i}]").bytesize).to be <= length
154
+ end
155
+ end
156
+ end
157
+
158
+ context "containing elements with mixed sizes" do
159
+ let(:count) { 10 }
160
+ let(:list) { (count - 1).times.map { "a" * 20 } + ["b" * 100]}
161
+ let(:length) { 50 }
162
+
163
+ it "should truncate elements that exceed the length" do
164
+ expect(subject).to receive(:filter_matched).once
165
+
166
+ subject.filter(event)
167
+
168
+ expect(event.get("[example][#{count - 1}]").bytesize).to be <= length
169
+ end
95
170
  end
96
171
  end
97
172
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-filter-truncate
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.4
4
+ version: 1.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-11-07 00:00:00.000000000 Z
11
+ date: 2023-05-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
49
49
  requirements:
50
50
  - - "~>"
51
51
  - !ruby/object:Gem::Version
52
- version: 0.0.7
52
+ version: 0.0.8
53
53
  name: flores
54
54
  prerelease: false
55
55
  type: :development
@@ -57,7 +57,7 @@ dependencies:
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: 0.0.7
60
+ version: 0.0.8
61
61
  description: This gem is a Logstash plugin required to be installed on top of the
62
62
  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
63
63
  gem is not a stand-alone program
@@ -97,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
97
97
  - !ruby/object:Gem::Version
98
98
  version: '0'
99
99
  requirements: []
100
- rubyforge_project:
101
- rubygems_version: 2.6.11
100
+ rubygems_version: 3.2.33
102
101
  signing_key:
103
102
  specification_version: 4
104
103
  summary: Truncates fields longer than a given length