logstash-filter-mutate 3.5.0 → 3.5.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +15 -7
- data/lib/logstash/filters/mutate.rb +5 -6
- data/logstash-filter-mutate.gemspec +2 -1
- data/spec/filters/integration/multi_stage_spec.rb +20 -48
- data/spec/filters/mutate_spec.rb +38 -24
- metadata +17 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5879507831fc15a821590956915fa601801af67d70636e26b1faf6652a743962
|
4
|
+
data.tar.gz: f387463d9e4ebfe44ce007461d0313ce7e172ab8260ca6775d0a95531b6480a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a2c3817cba6d8f6f02aae7f4c5dcc890dab263db38f7d8fc30e74ac735f20837c663c5c5913cf9c9743a9946f738f7f8b088aef047c606d37773e8cff78df54
|
7
|
+
data.tar.gz: 69a235e0bf9e8434ce8b5fe06c990053ef83649885bce61c375d7a1d5dc42ea54d4a9fdb88fd8de6a4fdb99620b97f9a5de0214a7f12f5ba6373bf77bbae0aae
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,20 @@
|
|
1
|
+
## 3.5.4
|
2
|
+
- DOC: In 'replace' documentation, mention 'add' behavior [#155](https://github.com/logstash-plugins/logstash-filter-mutate/pull/155)
|
3
|
+
- DOC: Add warning about #27 [#101](https://github.com/logstash-plugins/logstash-filter-mutate/pull/101)
|
4
|
+
|
5
|
+
## 3.5.3
|
6
|
+
- DOC: Expand description and behaviors for `rename` option [#156](https://github.com/logstash-plugins/logstash-filter-mutate/pull/156)
|
7
|
+
|
8
|
+
## 3.5.2
|
9
|
+
- Fix: ensure that when an error occurs during registration, we use the correct i18n key to propagate the error message in a useful manner [#154](https://github.com/logstash-plugins/logstash-filter-mutate/pull/154)
|
10
|
+
|
11
|
+
## 3.5.1
|
12
|
+
- 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)
|
13
|
+
|
14
|
+
## 3.5.0
|
15
|
+
- Fix: eliminated possible pipeline crashes; when a failure occurs during the application of this mutate filter, the rest of
|
16
|
+
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)
|
17
|
+
|
1
18
|
## 3.4.0
|
2
19
|
- Added ability to directly convert from integer and float to boolean [#127](https://github.com/logstash-plugins/logstash-filter-mutate/pull/127)
|
3
20
|
|
data/LICENSE
CHANGED
@@ -1,13 +1,202 @@
|
|
1
|
-
Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
|
2
1
|
|
3
|
-
|
4
|
-
|
5
|
-
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
6
5
|
|
7
|
-
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
8
7
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
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.
|
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
@@ -44,19 +44,19 @@ Mutations in a config file are executed in this order:
|
|
44
44
|
* merge
|
45
45
|
* copy
|
46
46
|
|
47
|
-
|
47
|
+
Warning: Each mutation must be in its own code block if the sequence of operations needs to be preserved.
|
48
48
|
|
49
49
|
Example:
|
50
50
|
[source,ruby]
|
51
51
|
-----
|
52
52
|
filter {
|
53
53
|
mutate {
|
54
|
-
split =>
|
55
|
-
add_field => { "shortHostname" => "%{hostname[0]}" }
|
54
|
+
split => { "hostname" => "." }
|
55
|
+
add_field => { "shortHostname" => "%{[hostname][0]}" }
|
56
56
|
}
|
57
57
|
|
58
58
|
mutate {
|
59
|
-
rename =>
|
59
|
+
rename => {"shortHostname" => "hostname"}
|
60
60
|
}
|
61
61
|
}
|
62
62
|
-----
|
@@ -111,10 +111,10 @@ Valid conversion targets, and their expected behaviour with different inputs are
|
|
111
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)
|
112
112
|
* `float`:
|
113
113
|
- integers are converted to floats
|
114
|
-
- strings are parsed; comma-separators and dot-decimals are supported (e.g., `"1,000.5"` produces
|
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)
|
115
115
|
- boolean true and boolean false are converted to `1.0` and `0.0` respectively
|
116
116
|
* `float_eu`:
|
117
|
-
- same as `float`, except string values support dot-separators and comma-decimals (e.g., `"1.000,5"` produces
|
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)
|
118
118
|
* `string`:
|
119
119
|
- all values are stringified and encoded with UTF-8
|
120
120
|
* `boolean`:
|
@@ -265,6 +265,13 @@ Example:
|
|
265
265
|
|
266
266
|
Rename one or more fields.
|
267
267
|
|
268
|
+
If the destination field already exists, its value is replaced.
|
269
|
+
|
270
|
+
If one of the source fields doesn't exist, no action is performed for that field.
|
271
|
+
(This is not considered an error; the `tag_on_failure` tag is not applied.)
|
272
|
+
|
273
|
+
When renaming multiple fields, the order of operations is not guaranteed.
|
274
|
+
|
268
275
|
Example:
|
269
276
|
[source,ruby]
|
270
277
|
filter {
|
@@ -280,7 +287,8 @@ Example:
|
|
280
287
|
* Value type is <<hash,hash>>
|
281
288
|
* There is no default value for this setting.
|
282
289
|
|
283
|
-
Replace the value of a field with a new value
|
290
|
+
Replace the value of a field with a new value, or add the field if it
|
291
|
+
doesn't already exist. The new value can include `%{foo}` strings
|
284
292
|
to help you build a new value from other parts of the event.
|
285
293
|
|
286
294
|
Example:
|
@@ -220,7 +220,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
|
|
220
220
|
@convert.nil? or @convert.each do |field, type|
|
221
221
|
if !valid_conversions.include?(type)
|
222
222
|
raise LogStash::ConfigurationError, I18n.t(
|
223
|
-
"logstash.
|
223
|
+
"logstash.runner.configuration.invalid_plugin_register",
|
224
224
|
:plugin => "filter",
|
225
225
|
:type => "mutate",
|
226
226
|
:error => "Invalid conversion type '#{type}', expected one of '#{valid_conversions.join(',')}'"
|
@@ -232,7 +232,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
|
|
232
232
|
@gsub.nil? or @gsub.each_slice(3) do |field, needle, replacement|
|
233
233
|
if [field, needle, replacement].any? {|n| n.nil?}
|
234
234
|
raise LogStash::ConfigurationError, I18n.t(
|
235
|
-
"logstash.
|
235
|
+
"logstash.runner.configuration.invalid_plugin_register",
|
236
236
|
:plugin => "filter",
|
237
237
|
:type => "mutate",
|
238
238
|
:error => "Invalid gsub configuration #{[field, needle, replacement]}. gsub requires 3 non-nil elements per config entry"
|
@@ -424,8 +424,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
|
|
424
424
|
(elem.is_a?(String) ? elem.upcase : elem)
|
425
425
|
end
|
426
426
|
when String
|
427
|
-
|
428
|
-
original.upcase! || original
|
427
|
+
original.upcase
|
429
428
|
else
|
430
429
|
@logger.debug? && @logger.debug("Can't uppercase something that isn't a string", :field => field, :value => original)
|
431
430
|
original
|
@@ -445,7 +444,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
|
|
445
444
|
(elem.is_a?(String) ? elem.downcase : elem)
|
446
445
|
end
|
447
446
|
when String
|
448
|
-
original.downcase
|
447
|
+
original.downcase
|
449
448
|
else
|
450
449
|
@logger.debug? && @logger.debug("Can't lowercase something that isn't a string", :field => field, :value => original)
|
451
450
|
original
|
@@ -465,7 +464,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
|
|
465
464
|
(elem.is_a?(String) ? elem.capitalize : elem)
|
466
465
|
end
|
467
466
|
when String
|
468
|
-
original.capitalize
|
467
|
+
original.capitalize
|
469
468
|
else
|
470
469
|
@logger.debug? && @logger.debug("Can't capitalize something that isn't a string", :field => field, :value => original)
|
471
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.5.
|
4
|
+
s.version = '3.5.4'
|
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
|
-
|
6
|
-
#
|
7
|
-
#
|
8
|
-
|
9
|
-
|
10
|
-
|
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
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
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
|
-
|
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
|
-
|
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
|
-
|
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
|
|
data/spec/filters/mutate_spec.rb
CHANGED
@@ -153,6 +153,21 @@ describe LogStash::Filters::Mutate do
|
|
153
153
|
expect(event).not_to include("fake_field")
|
154
154
|
end
|
155
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
|
156
171
|
end
|
157
172
|
end
|
158
173
|
|
@@ -306,7 +321,7 @@ describe LogStash::Filters::Mutate do
|
|
306
321
|
CONFIG
|
307
322
|
|
308
323
|
sample "not_really_important" do
|
309
|
-
expect {subject}.to raise_error
|
324
|
+
expect {subject}.to raise_error(LogStash::ConfigurationError, /Invalid conversion type/)
|
310
325
|
end
|
311
326
|
end
|
312
327
|
describe "invalid gsub triad should raise a configuration error" do
|
@@ -319,7 +334,7 @@ describe LogStash::Filters::Mutate do
|
|
319
334
|
CONFIG
|
320
335
|
|
321
336
|
sample "not_really_important" do
|
322
|
-
expect {subject}.to raise_error
|
337
|
+
expect {subject}.to raise_error(LogStash::ConfigurationError, /Invalid gsub configuration/)
|
323
338
|
end
|
324
339
|
end
|
325
340
|
end
|
@@ -399,10 +414,9 @@ describe LogStash::Filters::Mutate do
|
|
399
414
|
}
|
400
415
|
|
401
416
|
sample event do
|
402
|
-
|
403
|
-
expect(subject.get("
|
404
|
-
expect(subject.get("
|
405
|
-
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ûÿ"]
|
406
420
|
end
|
407
421
|
end
|
408
422
|
|
@@ -570,7 +584,7 @@ describe LogStash::Filters::Mutate do
|
|
570
584
|
end
|
571
585
|
end
|
572
586
|
end
|
573
|
-
|
587
|
+
|
574
588
|
|
575
589
|
describe "convert to float_eu" do
|
576
590
|
config <<-CONFIG
|
@@ -745,8 +759,8 @@ describe LogStash::Filters::Mutate do
|
|
745
759
|
CONFIG
|
746
760
|
|
747
761
|
sample("field_one" => "value", "x" => "one") do
|
748
|
-
|
749
|
-
|
762
|
+
expect(subject).to_not include("field_one")
|
763
|
+
expect(subject).to include("destination")
|
750
764
|
end
|
751
765
|
end
|
752
766
|
|
@@ -760,8 +774,8 @@ describe LogStash::Filters::Mutate do
|
|
760
774
|
CONFIG
|
761
775
|
|
762
776
|
sample("field_one" => "value", "x" => "one") do
|
763
|
-
|
764
|
-
|
777
|
+
expect(subject).to_not include("origin")
|
778
|
+
expect(subject).to include("field_one")
|
765
779
|
end
|
766
780
|
end
|
767
781
|
|
@@ -776,7 +790,7 @@ describe LogStash::Filters::Mutate do
|
|
776
790
|
|
777
791
|
sample({ "foo" => { "bar" => "1000" } }) do
|
778
792
|
expect(subject.get("[foo][bar]")).to eq 1000
|
779
|
-
expect(subject.get("[foo][bar]")).to be_a(
|
793
|
+
expect(subject.get("[foo][bar]")).to be_a(Integer)
|
780
794
|
end
|
781
795
|
end
|
782
796
|
|
@@ -791,7 +805,7 @@ describe LogStash::Filters::Mutate do
|
|
791
805
|
|
792
806
|
sample({ "foo" => ["100", "200"] }) do
|
793
807
|
expect(subject.get("[foo][0]")).to eq 100
|
794
|
-
expect(subject.get("[foo][0]")).to be_a(
|
808
|
+
expect(subject.get("[foo][0]")).to be_a(Integer)
|
795
809
|
end
|
796
810
|
end
|
797
811
|
|
@@ -812,15 +826,15 @@ describe LogStash::Filters::Mutate do
|
|
812
826
|
|
813
827
|
sample({ "foo" => [false, true, "0", "1", "2"] }) do
|
814
828
|
expect(subject.get("[foo][0]")).to eq 0
|
815
|
-
expect(subject.get("[foo][0]")).to be_a(
|
829
|
+
expect(subject.get("[foo][0]")).to be_a(Integer)
|
816
830
|
expect(subject.get("[foo][1]")).to eq 1
|
817
|
-
expect(subject.get("[foo][1]")).to be_a(
|
831
|
+
expect(subject.get("[foo][1]")).to be_a(Integer)
|
818
832
|
expect(subject.get("[foo][2]")).to eq 0
|
819
|
-
expect(subject.get("[foo][2]")).to be_a(
|
833
|
+
expect(subject.get("[foo][2]")).to be_a(Integer)
|
820
834
|
expect(subject.get("[foo][3]")).to eq 1
|
821
|
-
expect(subject.get("[foo][3]")).to be_a(
|
835
|
+
expect(subject.get("[foo][3]")).to be_a(Integer)
|
822
836
|
expect(subject.get("[foo][4]")).to eq 2
|
823
|
-
expect(subject.get("[foo][4]")).to be_a(
|
837
|
+
expect(subject.get("[foo][4]")).to be_a(Integer)
|
824
838
|
end
|
825
839
|
end
|
826
840
|
|
@@ -840,11 +854,11 @@ describe LogStash::Filters::Mutate do
|
|
840
854
|
|
841
855
|
sample({ "foo" => ["1,000", "1,234,567.8", "123.4"] }) do
|
842
856
|
expect(subject.get("[foo][0]")).to eq 1000
|
843
|
-
expect(subject.get("[foo][0]")).to be_a(
|
857
|
+
expect(subject.get("[foo][0]")).to be_a(Integer)
|
844
858
|
expect(subject.get("[foo][1]")).to eq 1234567
|
845
|
-
expect(subject.get("[foo][1]")).to be_a(
|
859
|
+
expect(subject.get("[foo][1]")).to be_a(Integer)
|
846
860
|
expect(subject.get("[foo][2]")).to eq 123
|
847
|
-
expect(subject.get("[foo][2]")).to be_a(
|
861
|
+
expect(subject.get("[foo][2]")).to be_a(Integer)
|
848
862
|
end
|
849
863
|
end
|
850
864
|
|
@@ -888,11 +902,11 @@ describe LogStash::Filters::Mutate do
|
|
888
902
|
|
889
903
|
sample({ "foo" => ["1.000", "1.234.567,8", "123,4"] }) do
|
890
904
|
expect(subject.get("[foo][0]")).to eq 1000
|
891
|
-
expect(subject.get("[foo][0]")).to be_a(
|
905
|
+
expect(subject.get("[foo][0]")).to be_a(Integer)
|
892
906
|
expect(subject.get("[foo][1]")).to eq 1234567
|
893
|
-
expect(subject.get("[foo][1]")).to be_a(
|
907
|
+
expect(subject.get("[foo][1]")).to be_a(Integer)
|
894
908
|
expect(subject.get("[foo][2]")).to eq 123
|
895
|
-
expect(subject.get("[foo][2]")).to be_a(
|
909
|
+
expect(subject.get("[foo][2]")).to be_a(Integer)
|
896
910
|
end
|
897
911
|
end
|
898
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.5.
|
4
|
+
version: 3.5.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Elastic
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-09-29 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:
|
@@ -112,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
112
126
|
- !ruby/object:Gem::Version
|
113
127
|
version: '0'
|
114
128
|
requirements: []
|
115
|
-
|
116
|
-
rubygems_version: 2.6.13
|
129
|
+
rubygems_version: 3.1.6
|
117
130
|
signing_key:
|
118
131
|
specification_version: 4
|
119
132
|
summary: Performs mutations on fields
|