logstash-filter-mutate 3.3.2 → 3.5.1

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: 7e984a5018bec5903f3731c447c9e1fffe4b149c0c2e27ce9055e14f21deb9c0
4
- data.tar.gz: 2b3c094ca15d06ac17c6746673ca31e40b7ca41b2217bd3c0f0ea8476c27f4c6
3
+ metadata.gz: 5eff46dce19ce289664364fdb1d47dbb79ce30b62a55646c9210fad216f1f0bb
4
+ data.tar.gz: 6e4944bef0a9b9da0ab0cf985148b9866884753f53d14b408b770cf8e97b6ad6
5
5
  SHA512:
6
- metadata.gz: e7286e1ea17e30d46e942a7c8d1a9107c57a11d0158dc7bb979b1ac09c0b85a94159480b8b568b197c73d922369c90c0c85ca8e356e6648b501cc007c28a7fab
7
- data.tar.gz: 7480daecb2a3c584302b6296597bc3d0f8583286ace082d6106daf6555c28705ecc73e6d28c0e8b92d41374fedf210f5cac156f5c1e431fa9f33f6709774272d
6
+ metadata.gz: 2b0d285df7cdd66b59173c690e2105af45074a38db77fa7bf564bcb8f827285f5b2547e79f41fc86473b09e9460143a91d23bb42ab637d227a63402a6bbd2cc3
7
+ data.tar.gz: 9361cc2a7f9e51c22f0dfe21bf944989dc19b8a31ecfd22e69e5b6907137626a70738d52d32fb9588d8bcdea8d3b55cb8597e3444cc8576bb4093ad79fc736a1
data/CHANGELOG.md CHANGED
@@ -1,3 +1,20 @@
1
+ ## 3.5.1
2
+ - Fix: removed a minor optimization in case-conversion helpers that could result in a race condition in very rare and specific situations [#151](https://github.com/logstash-plugins/logstash-filter-mutate/pull/151)
3
+
4
+ ## 3.5.0
5
+ - Fix: eliminated possible pipeline crashes; when a failure occurs during the application of this mutate filter, the rest of
6
+ the operations are now aborted and a configurable tag is added to the event [#136](https://github.com/logstash-plugins/logstash-filter-mutate/pull/136)
7
+
8
+ ## 3.4.0
9
+ - Added ability to directly convert from integer and float to boolean [#127](https://github.com/logstash-plugins/logstash-filter-mutate/pull/127)
10
+
11
+ ## 3.3.4
12
+ - Changed documentation to clarify execution order and to provide workaround
13
+ [#128](https://github.com/logstash-plugins/logstash-filter-mutate/pull/128)
14
+
15
+ ## 3.3.3
16
+ - Changed documentation to clarify use of `replace` config option [#125](https://github.com/logstash-plugins/logstash-filter-mutate/pull/125)
17
+
1
18
  ## 3.3.2
2
19
  - Fix: when converting to `float` and `float_eu`, explicitly support same range of inputs as their integer counterparts; eliminates a regression introduced in 3.3.1 in which support for non-string inputs was inadvertently removed.
3
20
 
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012-2018 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-mutate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-mutate)
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-mutate.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-mutate)
4
4
 
5
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
6
 
data/docs/index.asciidoc CHANGED
@@ -23,6 +23,44 @@ include::{include_path}/plugin_header.asciidoc[]
23
23
  The mutate filter allows you to perform general mutations on fields. You
24
24
  can rename, remove, replace, and modify fields in your events.
25
25
 
26
+ [id="plugins-{type}s-{plugin}-proc_order"]
27
+ ===== Processing order
28
+
29
+ Mutations in a config file are executed in this order:
30
+
31
+ * coerce
32
+ * rename
33
+ * update
34
+ * replace
35
+ * convert
36
+ * gsub
37
+ * uppercase
38
+ * capitalize
39
+ * lowercase
40
+ * strip
41
+ * remove
42
+ * split
43
+ * join
44
+ * merge
45
+ * copy
46
+
47
+ You can control the order by using separate mutate blocks.
48
+
49
+ Example:
50
+ [source,ruby]
51
+ -----
52
+ filter {
53
+ mutate {
54
+ split => { "hostname" => "." }
55
+ add_field => { "shortHostname" => "%{[hostname][0]}" }
56
+ }
57
+
58
+ mutate {
59
+ rename => ["shortHostname", "hostname" ]
60
+ }
61
+ }
62
+ -----
63
+
26
64
  [id="plugins-{type}s-{plugin}-options"]
27
65
  ==== Mutate Filter Configuration Options
28
66
 
@@ -45,6 +83,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
45
83
  | <<plugins-{type}s-{plugin}-update>> |<<hash,hash>>|No
46
84
  | <<plugins-{type}s-{plugin}-uppercase>> |<<array,array>>|No
47
85
  | <<plugins-{type}s-{plugin}-capitalize>> |<<array,array>>|No
86
+ | <<plugins-{type}s-{plugin}-tag_on_failure>> |<<string,string>>|No
48
87
  |=======================================================================
49
88
 
50
89
  Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -72,17 +111,22 @@ Valid conversion targets, and their expected behaviour with different inputs are
72
111
  - same as `integer`, except string values support dot-separators and comma-decimals (e.g., `"1.000"` produces an integer with value of one thousand)
73
112
  * `float`:
74
113
  - integers are converted to floats
75
- - strings are parsed; comma-separators and dot-decimals are supported (e.g., `"1,000.5"` produces an integer with value of one thousand and one half)
114
+ - strings are parsed; comma-separators and dot-decimals are supported (e.g., `"1,000.5"` produces a float with value of one thousand and one half)
76
115
  - boolean true and boolean false are converted to `1.0` and `0.0` respectively
77
116
  * `float_eu`:
78
- - same as `float`, except string values support dot-separators and comma-decimals (e.g., `"1.000,5"` produces an integer with value of one thousand and one half)
117
+ - same as `float`, except string values support dot-separators and comma-decimals (e.g., `"1.000,5"` produces a float with value of one thousand and one half)
79
118
  * `string`:
80
119
  - all values are stringified and encoded with UTF-8
81
120
  * `boolean`:
82
- - strings `"true"`, `"t"`, `"yes"`, `"y"`, and `"1"` are converted to boolean `true`
83
- - strings `"false"`, `"f"`, `"no"`, `"n"`, and `"0"` are converted to boolean `false`
121
+ - integer 0 is converted to boolean `false`
122
+ - integer 1 is converted to boolean `true`
123
+ - float 0.0 is converted to boolean `false`
124
+ - float 1.0 is converted to boolean `true`
125
+ - strings `"true"`, `"t"`, `"yes"`, `"y"`, `"1"`and `"1.0"` are converted to boolean `true`
126
+ - strings `"false"`, `"f"`, `"no"`, `"n"`, `"0"` and `"0.0"` are converted to boolean `false`
84
127
  - empty strings are converted to boolean `false`
85
128
  - all other values pass straight through without conversion and log a warning message
129
+ - for arrays each value gets processed separately using rules above
86
130
 
87
131
  This plugin can convert multiple fields in the same document, see the example below.
88
132
 
@@ -236,7 +280,7 @@ Example:
236
280
  * Value type is <<hash,hash>>
237
281
  * There is no default value for this setting.
238
282
 
239
- Replace a field with a new value. The new value can include `%{foo}` strings
283
+ Replace the value of a field with a new value. The new value can include `%{foo}` strings
240
284
  to help you build a new value from other parts of the event.
241
285
 
242
286
  Example:
@@ -329,5 +373,14 @@ Example:
329
373
  }
330
374
  }
331
375
 
376
+ [id="plugins-{type}s-{plugin}-tag_on_failure"]
377
+ ===== `tag_on_failure`
378
+
379
+ * Value type is <<string,string>>
380
+ * The default value for this setting is `_mutate_error`
381
+
382
+ If a failure occurs during the application of this mutate filter, the rest of
383
+ the operations are aborted and the provided tag is added to the event.
384
+
332
385
  [id="plugins-{type}s-{plugin}-common-options"]
333
386
  include::{include_path}/{type}.asciidoc[]
@@ -207,8 +207,11 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
207
207
  # }
208
208
  config :copy, :validate => :hash
209
209
 
210
- TRUE_REGEX = (/^(true|t|yes|y|1)$/i).freeze
211
- FALSE_REGEX = (/^(false|f|no|n|0)$/i).freeze
210
+ # Tag to apply if the operation errors
211
+ config :tag_on_failure, :validate => :string, :default => '_mutate_error'
212
+
213
+ TRUE_REGEX = (/^(true|t|yes|y|1|1.0)$/i).freeze
214
+ FALSE_REGEX = (/^(false|f|no|n|0|0.0)$/i).freeze
212
215
  CONVERT_PREFIX = "convert_".freeze
213
216
 
214
217
  def register
@@ -262,6 +265,11 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
262
265
  copy(event) if @copy
263
266
 
264
267
  filter_matched(event)
268
+ rescue => ex
269
+ meta = { :exception => ex.message }
270
+ meta[:backtrace] = ex.backtrace if logger.debug?
271
+ logger.warn('Exception caught while applying mutate filter', meta)
272
+ event.tag(@tag_on_failure)
265
273
  end
266
274
 
267
275
  private
@@ -327,8 +335,8 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
327
335
  end
328
336
 
329
337
  def convert_boolean(value)
330
- return true if value =~ TRUE_REGEX
331
- return false if value.empty? || value =~ FALSE_REGEX
338
+ return true if value.to_s =~ TRUE_REGEX
339
+ return false if value.to_s.empty? || value.to_s =~ FALSE_REGEX
332
340
  @logger.warn("Failed to convert #{value} into boolean.")
333
341
  value
334
342
  end
@@ -416,8 +424,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
416
424
  (elem.is_a?(String) ? elem.upcase : elem)
417
425
  end
418
426
  when String
419
- # nil means no change was made to the String
420
- original.upcase! || original
427
+ original.upcase
421
428
  else
422
429
  @logger.debug? && @logger.debug("Can't uppercase something that isn't a string", :field => field, :value => original)
423
430
  original
@@ -437,7 +444,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
437
444
  (elem.is_a?(String) ? elem.downcase : elem)
438
445
  end
439
446
  when String
440
- original.downcase! || original
447
+ original.downcase
441
448
  else
442
449
  @logger.debug? && @logger.debug("Can't lowercase something that isn't a string", :field => field, :value => original)
443
450
  original
@@ -457,7 +464,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
457
464
  (elem.is_a?(String) ? elem.capitalize : elem)
458
465
  end
459
466
  when String
460
- original.capitalize! || original
467
+ original.capitalize
461
468
  else
462
469
  @logger.debug? && @logger.debug("Can't capitalize something that isn't a string", :field => field, :value => original)
463
470
  original
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-filter-mutate'
4
- s.version = '3.3.2'
4
+ s.version = '3.5.1'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "Performs mutations on fields"
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"
@@ -23,5 +23,6 @@ Gem::Specification.new do |s|
23
23
  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
24
24
  s.add_development_dependency "logstash-patterns-core"
25
25
  s.add_development_dependency "logstash-filter-grok"
26
+ s.add_development_dependency "logstash-codec-plain"
26
27
  s.add_development_dependency "logstash-devutils"
27
28
  end
@@ -1,71 +1,43 @@
1
1
  # encoding: utf-8
2
2
  require "logstash/devutils/rspec/spec_helper"
3
- require "logstash/filters/mutate"
4
3
 
5
- # running mutate which depends on grok outside a logstash package means
6
- # LOGSTASH_HOME will not be defined, so let's set it here
7
- # before requiring the grok filter
8
- unless LogStash::Environment.const_defined?(:LOGSTASH_HOME)
9
- LogStash::Environment::LOGSTASH_HOME = File.expand_path("../../../", __FILE__)
10
- end
11
-
12
- describe LogStash::Filters::Mutate do
13
- let(:pipeline) do
14
- new_pipeline_from_string(config)
15
- end
16
-
17
- let(:events) do
18
- arr = event.is_a?(Array) ? event : [event]
19
- arr.map do |evt|
20
- LogStash::Event.new(evt.is_a?(String) ? LogStash::Json.load(evt) : evt)
21
- end
4
+ module LogStash::Environment
5
+ # running mutate which depends on grok outside a logstash package means
6
+ # LOGSTASH_HOME will not be defined, so let's set it here
7
+ # before requiring the grok filter
8
+ unless self.const_defined?(:LOGSTASH_HOME)
9
+ LOGSTASH_HOME = File.expand_path("../../../", __FILE__)
22
10
  end
23
11
 
24
- let(:results) do
25
- pipeline.instance_eval { @filters.each(&:register) }
26
- results = []
27
- events.each do |evt|
28
- # filter call the block on all filtered events, included new events added by the filter
29
- pipeline.filter(evt) do |filtered_event|
30
- results.push(filtered_event)
31
- end
12
+ # also :pattern_path method must exist (due grok filter)
13
+ unless self.method_defined?(:pattern_path)
14
+ def pattern_path(path)
15
+ ::File.join(LOGSTASH_HOME, "patterns", path)
32
16
  end
33
- pipeline.flush_filters(:final => true) { |flushed_event| results << flushed_event }
34
-
35
- results.select { |e| !e.cancelled? }
36
17
  end
18
+ end
37
19
 
38
- describe 'MUTATE-33: multi stage with json, grok and mutate, Case mutation' do
39
- let(:event) do
40
- "{\"message\":\"hello WORLD\",\"lower1\":\"PPQQRRSS\",\"lower2\":\"pppqqq\"}"
41
- end
20
+ describe 'LogStash::Filters::Mutate' do
42
21
 
22
+ context 'MUTATE-33: multi stage with json, grok and mutate, Case mutation' do
43
23
  let(:config) do
44
24
  <<-CONFIG
45
- filter {
46
- grok {
25
+ filter {
26
+ grok {
47
27
  match => { "message" => "(?:hello) %{WORD:bar}" }
48
28
  break_on_match => false
29
+ }
30
+ mutate {
31
+ lowercase => [ "bar", "lower1", "lower2" ]
32
+ }
49
33
  }
50
- mutate {
51
- lowercase => [ "bar", "lower1", "lower2" ]
52
- }
53
- }
54
34
  CONFIG
55
35
  end
56
36
 
57
- it 'change case of the target, bar value is lowercase' do
37
+ sample("message" => "hello WORLD", "lower1" => "PPQQRRSS", "lower2" => "pppqqq") do
58
38
  result = results.first
59
39
  expect(result.get("bar")).to eq('world')
60
- end
61
-
62
- it 'change case of the target, lower1 value is lowercase' do
63
- result = results.first
64
40
  expect(result.get("lower1")).to eq("ppqqrrss")
65
- end
66
-
67
- it 'change case of the target, lower2 value is lowercase' do
68
- result = results.first
69
41
  expect(result.get("lower2")).to eq("pppqqq")
70
42
  end
71
43
 
@@ -23,6 +23,56 @@ module LogStash::Environment
23
23
  end
24
24
  end
25
25
 
26
+ logstash_version = Gem::Version.create(LOGSTASH_CORE_VERSION)
27
+
28
+ if (Gem::Requirement.create('~> 7.0').satisfied_by?(logstash_version) ||
29
+ (Gem::Requirement.create('~> 6.4').satisfied_by?(logstash_version) && LogStash::SETTINGS.get('config.field_reference.parser') == 'STRICT'))
30
+ describe LogStash::Filters::Mutate do
31
+ let(:config) { Hash.new }
32
+ subject(:mutate_filter) { LogStash::Filters::Mutate.new(config) }
33
+
34
+ before(:each) { mutate_filter.register }
35
+
36
+ let(:event) { LogStash::Event.new(attrs) }
37
+
38
+ context 'when operation would cause an error' do
39
+
40
+ let(:invalid_field_name) { "[[][[[[]message" }
41
+ let(:config) do
42
+ super().merge("add_field" => {invalid_field_name => "nope"})
43
+ end
44
+
45
+ shared_examples('catch and tag error') do
46
+ let(:expected_tag) { '_mutate_error' }
47
+
48
+ let(:event) { LogStash::Event.new({"message" => "foo"})}
49
+
50
+ context 'when the event is filtered' do
51
+ before(:each) { mutate_filter.filter(event) }
52
+ it 'does not raise an exception' do
53
+ # noop
54
+ end
55
+
56
+ it 'tags the event with the expected tag' do
57
+ expect(event).to include('tags')
58
+ expect(event.get('tags')).to include(expected_tag)
59
+ end
60
+ end
61
+ end
62
+
63
+ context 'when `tag_on_failure` is not provided' do
64
+ include_examples 'catch and tag error'
65
+ end
66
+
67
+ context 'when `tag_on_failure` is provided' do
68
+ include_examples 'catch and tag error' do
69
+ let(:expected_tag) { 'my_custom_tag' }
70
+ let(:config) { super().merge('tag_on_failure' => expected_tag) }
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
26
76
 
27
77
  describe LogStash::Filters::Mutate do
28
78
 
@@ -103,6 +153,21 @@ describe LogStash::Filters::Mutate do
103
153
  expect(event).not_to include("fake_field")
104
154
  end
105
155
  end
156
+ context "avoid mutating contents of field, as they may be shared" do
157
+ let(:original_value) { "oRiGiNaL vAlUe".freeze }
158
+ let(:shared_value) { original_value.dup }
159
+ let(:attrs) { {"field" => shared_value } }
160
+ let(:config) do
161
+ {
162
+ operation => "field"
163
+ }
164
+ end
165
+
166
+ it 'should not mutate the value' do
167
+ subject.filter(event)
168
+ expect(shared_value).to eq(original_value)
169
+ end
170
+ end
106
171
  end
107
172
  end
108
173
 
@@ -349,10 +414,9 @@ describe LogStash::Filters::Mutate do
349
414
  }
350
415
 
351
416
  sample event do
352
- # ATM, only the ASCII characters will case change
353
- expect(subject.get("lowerme")).to eq [ "АБВГД\0mmm", "こにちわ", "xyzółć", "nÎcË gÛŸ"]
354
- expect(subject.get("upperme")).to eq [ "аБвгд\0MMM", "こにちわ", "XYZółć", "NîCë Gûÿ"]
355
- expect(subject.get("capitalizeme")).to eq [ "АБВГД\u0000mmm", "こにちわ", "Xyzółć", "NÎcË gÛŸ"]
417
+ expect(subject.get("lowerme")).to eq [ "абвгд\0mmm", "こにちわ", "xyzółć", "nîcë gûÿ"]
418
+ expect(subject.get("upperme")).to eq [ "АБВГД\0MMM", "こにちわ", "XYZÓŁĆ", "NÎCË GÛŸ"]
419
+ expect(subject.get("capitalizeme")).to eq [ "Абвгд\0mmm", "こにちわ", "Xyzółć", "Nîcë gûÿ"]
356
420
  end
357
421
  end
358
422
 
@@ -373,45 +437,78 @@ describe LogStash::Filters::Mutate do
373
437
  config <<-CONFIG
374
438
  filter {
375
439
  mutate {
376
- convert => { "true_field" => "boolean" }
377
- convert => { "false_field" => "boolean" }
378
- convert => { "true_upper" => "boolean" }
379
- convert => { "false_upper" => "boolean" }
380
- convert => { "true_one" => "boolean" }
381
- convert => { "false_zero" => "boolean" }
382
- convert => { "true_yes" => "boolean" }
383
- convert => { "false_no" => "boolean" }
384
- convert => { "true_y" => "boolean" }
385
- convert => { "false_n" => "boolean" }
386
- convert => { "wrong_field" => "boolean" }
440
+ convert => { "true_field" => "boolean" }
441
+ convert => { "false_field" => "boolean" }
442
+ convert => { "true_upper" => "boolean" }
443
+ convert => { "false_upper" => "boolean" }
444
+ convert => { "true_one" => "boolean" }
445
+ convert => { "false_zero" => "boolean" }
446
+ convert => { "true_yes" => "boolean" }
447
+ convert => { "false_no" => "boolean" }
448
+ convert => { "true_y" => "boolean" }
449
+ convert => { "false_n" => "boolean" }
450
+ convert => { "wrong_field" => "boolean" }
451
+ convert => { "integer_false" => "boolean" }
452
+ convert => { "integer_true" => "boolean" }
453
+ convert => { "integer_negative" => "boolean" }
454
+ convert => { "integer_wrong" => "boolean" }
455
+ convert => { "float_true" => "boolean" }
456
+ convert => { "float_false" => "boolean" }
457
+ convert => { "float_negative" => "boolean" }
458
+ convert => { "float_wrong" => "boolean" }
459
+ convert => { "float_wrong2" => "boolean" }
460
+ convert => { "array" => "boolean" }
461
+ convert => { "hash" => "boolean" }
387
462
  }
388
463
  }
389
464
  CONFIG
390
465
  event = {
391
- "true_field" => "true",
392
- "false_field" => "false",
393
- "true_upper" => "True",
394
- "false_upper" => "False",
395
- "true_one" => "1",
396
- "false_zero" => "0",
397
- "true_yes" => "yes",
398
- "false_no" => "no",
399
- "true_y" => "Y",
400
- "false_n" => "N",
401
- "wrong_field" => "none of the above"
466
+ "true_field" => "true",
467
+ "false_field" => "false",
468
+ "true_upper" => "True",
469
+ "false_upper" => "False",
470
+ "true_one" => "1",
471
+ "false_zero" => "0",
472
+ "true_yes" => "yes",
473
+ "false_no" => "no",
474
+ "true_y" => "Y",
475
+ "false_n" => "N",
476
+ "wrong_field" => "none of the above",
477
+ "integer_false" => 0,
478
+ "integer_true" => 1,
479
+ "integer_negative"=> -1,
480
+ "integer_wrong" => 2,
481
+ "float_true" => 1.0,
482
+ "float_false" => 0.0,
483
+ "float_negative" => -1.0,
484
+ "float_wrong" => 1.0123,
485
+ "float_wrong2" => 0.01,
486
+ "array" => [ "1", "0", 0,1,2],
487
+ "hash" => { "a" => 0 }
402
488
  }
403
489
  sample event do
404
- expect(subject.get("true_field") ).to eq(true)
405
- expect(subject.get("false_field")).to eq(false)
406
- expect(subject.get("true_upper") ).to eq(true)
407
- expect(subject.get("false_upper")).to eq(false)
408
- expect(subject.get("true_one") ).to eq(true)
409
- expect(subject.get("false_zero") ).to eq(false)
410
- expect(subject.get("true_yes") ).to eq(true)
411
- expect(subject.get("false_no") ).to eq(false)
412
- expect(subject.get("true_y") ).to eq(true)
413
- expect(subject.get("false_n") ).to eq(false)
414
- expect(subject.get("wrong_field")).to eq("none of the above")
490
+ expect(subject.get("true_field") ).to eq(true)
491
+ expect(subject.get("false_field") ).to eq(false)
492
+ expect(subject.get("true_upper") ).to eq(true)
493
+ expect(subject.get("false_upper") ).to eq(false)
494
+ expect(subject.get("true_one") ).to eq(true)
495
+ expect(subject.get("false_zero") ).to eq(false)
496
+ expect(subject.get("true_yes") ).to eq(true)
497
+ expect(subject.get("false_no") ).to eq(false)
498
+ expect(subject.get("true_y") ).to eq(true)
499
+ expect(subject.get("false_n") ).to eq(false)
500
+ expect(subject.get("wrong_field") ).to eq("none of the above")
501
+ expect(subject.get("integer_false") ).to eq(false)
502
+ expect(subject.get("integer_true") ).to eq(true)
503
+ expect(subject.get("integer_negative")).to eq(-1)
504
+ expect(subject.get("integer_wrong") ).to eq(2)
505
+ expect(subject.get("float_true") ).to eq(true)
506
+ expect(subject.get("float_false") ).to eq(false)
507
+ expect(subject.get("float_negative") ).to eq(-1.0)
508
+ expect(subject.get("float_wrong") ).to eq(1.0123)
509
+ expect(subject.get("float_wrong2") ).to eq(0.01)
510
+ expect(subject.get("array") ).to eq([true, false, false, true,2])
511
+ expect(subject.get("hash") ).to eq({ "a" => 0 })
415
512
  end
416
513
  end
417
514
 
@@ -662,8 +759,8 @@ describe LogStash::Filters::Mutate do
662
759
  CONFIG
663
760
 
664
761
  sample("field_one" => "value", "x" => "one") do
665
- reject { subject }.include?("field_one")
666
- insist { subject }.include?("destination")
762
+ expect(subject).to_not include("field_one")
763
+ expect(subject).to include("destination")
667
764
  end
668
765
  end
669
766
 
@@ -677,8 +774,8 @@ describe LogStash::Filters::Mutate do
677
774
  CONFIG
678
775
 
679
776
  sample("field_one" => "value", "x" => "one") do
680
- reject { subject }.include?("origin")
681
- insist { subject }.include?("field_one")
777
+ expect(subject).to_not include("origin")
778
+ expect(subject).to include("field_one")
682
779
  end
683
780
  end
684
781
 
@@ -693,7 +790,7 @@ describe LogStash::Filters::Mutate do
693
790
 
694
791
  sample({ "foo" => { "bar" => "1000" } }) do
695
792
  expect(subject.get("[foo][bar]")).to eq 1000
696
- expect(subject.get("[foo][bar]")).to be_a(Fixnum)
793
+ expect(subject.get("[foo][bar]")).to be_a(Integer)
697
794
  end
698
795
  end
699
796
 
@@ -708,7 +805,7 @@ describe LogStash::Filters::Mutate do
708
805
 
709
806
  sample({ "foo" => ["100", "200"] }) do
710
807
  expect(subject.get("[foo][0]")).to eq 100
711
- expect(subject.get("[foo][0]")).to be_a(Fixnum)
808
+ expect(subject.get("[foo][0]")).to be_a(Integer)
712
809
  end
713
810
  end
714
811
 
@@ -729,15 +826,15 @@ describe LogStash::Filters::Mutate do
729
826
 
730
827
  sample({ "foo" => [false, true, "0", "1", "2"] }) do
731
828
  expect(subject.get("[foo][0]")).to eq 0
732
- expect(subject.get("[foo][0]")).to be_a(Fixnum)
829
+ expect(subject.get("[foo][0]")).to be_a(Integer)
733
830
  expect(subject.get("[foo][1]")).to eq 1
734
- expect(subject.get("[foo][1]")).to be_a(Fixnum)
831
+ expect(subject.get("[foo][1]")).to be_a(Integer)
735
832
  expect(subject.get("[foo][2]")).to eq 0
736
- expect(subject.get("[foo][2]")).to be_a(Fixnum)
833
+ expect(subject.get("[foo][2]")).to be_a(Integer)
737
834
  expect(subject.get("[foo][3]")).to eq 1
738
- expect(subject.get("[foo][3]")).to be_a(Fixnum)
835
+ expect(subject.get("[foo][3]")).to be_a(Integer)
739
836
  expect(subject.get("[foo][4]")).to eq 2
740
- expect(subject.get("[foo][4]")).to be_a(Fixnum)
837
+ expect(subject.get("[foo][4]")).to be_a(Integer)
741
838
  end
742
839
  end
743
840
 
@@ -757,11 +854,11 @@ describe LogStash::Filters::Mutate do
757
854
 
758
855
  sample({ "foo" => ["1,000", "1,234,567.8", "123.4"] }) do
759
856
  expect(subject.get("[foo][0]")).to eq 1000
760
- expect(subject.get("[foo][0]")).to be_a(Fixnum)
857
+ expect(subject.get("[foo][0]")).to be_a(Integer)
761
858
  expect(subject.get("[foo][1]")).to eq 1234567
762
- expect(subject.get("[foo][1]")).to be_a(Fixnum)
859
+ expect(subject.get("[foo][1]")).to be_a(Integer)
763
860
  expect(subject.get("[foo][2]")).to eq 123
764
- expect(subject.get("[foo][2]")).to be_a(Fixnum)
861
+ expect(subject.get("[foo][2]")).to be_a(Integer)
765
862
  end
766
863
  end
767
864
 
@@ -805,11 +902,11 @@ describe LogStash::Filters::Mutate do
805
902
 
806
903
  sample({ "foo" => ["1.000", "1.234.567,8", "123,4"] }) do
807
904
  expect(subject.get("[foo][0]")).to eq 1000
808
- expect(subject.get("[foo][0]")).to be_a(Fixnum)
905
+ expect(subject.get("[foo][0]")).to be_a(Integer)
809
906
  expect(subject.get("[foo][1]")).to eq 1234567
810
- expect(subject.get("[foo][1]")).to be_a(Fixnum)
907
+ expect(subject.get("[foo][1]")).to be_a(Integer)
811
908
  expect(subject.get("[foo][2]")).to eq 123
812
- expect(subject.get("[foo][2]")).to be_a(Fixnum)
909
+ expect(subject.get("[foo][2]")).to be_a(Integer)
813
910
  end
814
911
  end
815
912
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-filter-mutate
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.3.2
4
+ version: 3.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-05-01 00:00:00.000000000 Z
11
+ date: 2021-03-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,20 @@ dependencies:
58
58
  - - ">="
59
59
  - !ruby/object:Gem::Version
60
60
  version: '0'
61
+ - !ruby/object:Gem::Dependency
62
+ requirement: !ruby/object:Gem::Requirement
63
+ requirements:
64
+ - - ">="
65
+ - !ruby/object:Gem::Version
66
+ version: '0'
67
+ name: logstash-codec-plain
68
+ prerelease: false
69
+ type: :development
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
61
75
  - !ruby/object:Gem::Dependency
62
76
  requirement: !ruby/object:Gem::Requirement
63
77
  requirements: