logstash-filter-clone 3.0.4 → 4.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +16 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +105 -8
- data/lib/logstash/filters/clone.rb +27 -3
- data/logstash-filter-clone.gemspec +3 -3
- data/spec/filters/clone_spec.rb +105 -64
- metadata +21 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 667ee39a144272a71499a9b9d1bd86c8ff2a85be7724e1a31a661e2e7cd44084
|
|
4
|
+
data.tar.gz: 249f812faaefe68659a42d6dd1ed44de53d0842271b7afe8145332ba2ad6b368
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a958dc508462f1508ad5317e0c5bd9f31b908453a041c47d6f18a0b779eeff56df55466e59f204e33ba87c7a590a4d87525f6cfa15c4f9651582bc82fc79e358
|
|
7
|
+
data.tar.gz: 29506d3cb8aabda8c1b884896ffd79090b82d4f3fd6cf4dff0a52f55c293732fe296489d638b78038f8cf53d6b72d177969dc8c596e6261fdf8fe807e2d0f745
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,19 @@
|
|
|
1
|
+
## 4.1.1
|
|
2
|
+
- [Doc] Add ECS mapping table [#25](https://github.com/logstash-plugins/logstash-filter-clone/pull/25)
|
|
3
|
+
- [DOC] Added note that a new type field is added to the clone [#23](https://github.com/logstash-plugins/logstash-filter-clone/pull/23)
|
|
4
|
+
|
|
5
|
+
## 4.1.0
|
|
6
|
+
- Add ECS compatibility [#24](https://github.com/logstash-plugins/logstash-filter-clone/pull/24)
|
|
7
|
+
|
|
8
|
+
## 4.0.0
|
|
9
|
+
- Make 'clones' a required option
|
|
10
|
+
|
|
11
|
+
## 3.0.6
|
|
12
|
+
- Added a warning when 'clones' is empty since that results in a no-op https://github.com/logstash-plugins/logstash-filter-clone/issues/14
|
|
13
|
+
|
|
14
|
+
## 3.0.5
|
|
15
|
+
- Update gemspec summary
|
|
16
|
+
|
|
1
17
|
## 3.0.4
|
|
2
18
|
- Fix some documentation issues
|
|
3
19
|
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012–2016 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
|
-
[](https://travis-ci.com/logstash-plugins/logstash-filter-clone)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -22,11 +22,24 @@ include::{include_path}/plugin_header.asciidoc[]
|
|
|
22
22
|
|
|
23
23
|
The clone filter is for duplicating events.
|
|
24
24
|
A clone will be created for each type in the clone list.
|
|
25
|
-
The original event is left unchanged.
|
|
25
|
+
The original event is left unchanged and a `type` field is added to the clone.
|
|
26
26
|
Created events are inserted into the pipeline
|
|
27
27
|
as normal events and will be processed by the remaining pipeline configuration
|
|
28
28
|
starting from the filter that generated them (i.e. this plugin).
|
|
29
29
|
|
|
30
|
+
==== Event Metadata and the Elastic Common Schema (ECS)
|
|
31
|
+
This plugin adds a tag to a cloned event.
|
|
32
|
+
By default, the tag is stored in the `type` field.
|
|
33
|
+
When ECS is enabled, the tag is stored in the `tags` array field.
|
|
34
|
+
|
|
35
|
+
Here’s how ECS compatibility mode affects output.
|
|
36
|
+
[cols="<l,<l,e,<e"]
|
|
37
|
+
|=======================================================================
|
|
38
|
+
| ECS disabled | ECS v1 | Availability | Description
|
|
39
|
+
|
|
40
|
+
| type | tags | Always | a tag of cloned event
|
|
41
|
+
|=======================================================================
|
|
42
|
+
|
|
30
43
|
[id="plugins-{type}s-{plugin}-options"]
|
|
31
44
|
==== Clone Filter Configuration Options
|
|
32
45
|
|
|
@@ -35,7 +48,8 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
|
35
48
|
[cols="<,<,<",options="header",]
|
|
36
49
|
|=======================================================================
|
|
37
50
|
|Setting |Input type|Required
|
|
38
|
-
| <<plugins-{type}s-{plugin}-clones>> |<<array,array>>|
|
|
51
|
+
| <<plugins-{type}s-{plugin}-clones>> |<<array,array>>|Yes
|
|
52
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
|
|
39
53
|
|=======================================================================
|
|
40
54
|
|
|
41
55
|
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
|
@@ -46,12 +60,95 @@ filter plugins.
|
|
|
46
60
|
[id="plugins-{type}s-{plugin}-clones"]
|
|
47
61
|
===== `clones`
|
|
48
62
|
|
|
63
|
+
* This is a required setting.
|
|
49
64
|
* Value type is <<array,array>>
|
|
50
|
-
*
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
65
|
+
* There is no default value for this setting.
|
|
66
|
+
* a new clone will be created with a `type` of the given value in this list when ECS is disabled
|
|
67
|
+
* a new clone will be created with a `tags` of the given value in this list when ECS is enabled
|
|
68
|
+
|
|
69
|
+
Note: setting an empty array will not create any clones. A warning message is logged.
|
|
70
|
+
|
|
71
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
|
72
|
+
===== `ecs_compatibility`
|
|
73
|
+
|
|
74
|
+
* Value type is <<string,string>>
|
|
75
|
+
* Supported values are:
|
|
76
|
+
** `disabled`: does not use ECS-compatible field names
|
|
77
|
+
** `v1`: uses fields that are compatible with Elastic Common Schema
|
|
78
|
+
* Default value depends on which version of Logstash is running:
|
|
79
|
+
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
|
|
80
|
+
** Otherwise, the default value is `disabled`.
|
|
81
|
+
|
|
82
|
+
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
|
|
83
|
+
The value of this setting affects the behavior of the <<plugins-{type}s-{plugin}-clones>>
|
|
84
|
+
|
|
85
|
+
Example:
|
|
86
|
+
[source,ruby]
|
|
87
|
+
filter {
|
|
88
|
+
clone {
|
|
89
|
+
clones => ["sun", "moon"]
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
ECS disabled
|
|
94
|
+
[source,text]
|
|
95
|
+
-----
|
|
96
|
+
{
|
|
97
|
+
"@version" => "1",
|
|
98
|
+
"sequence" => 0,
|
|
99
|
+
"message" => "Hello World!",
|
|
100
|
+
"@timestamp" => 2021-03-24T11:20:36.226Z,
|
|
101
|
+
"host" => "example.com"
|
|
102
|
+
}
|
|
103
|
+
{
|
|
104
|
+
"@version" => "1",
|
|
105
|
+
"sequence" => 0,
|
|
106
|
+
"message" => "Hello World!",
|
|
107
|
+
"@timestamp" => 2021-03-24T11:20:36.226Z,
|
|
108
|
+
"type" => "sun",
|
|
109
|
+
"host" => "example.com"
|
|
110
|
+
}
|
|
111
|
+
{
|
|
112
|
+
"@version" => "1",
|
|
113
|
+
"sequence" => 0,
|
|
114
|
+
"message" => "Hello World!",
|
|
115
|
+
"@timestamp" => 2021-03-24T11:20:36.226Z,
|
|
116
|
+
"type" => "moon",
|
|
117
|
+
"host" => "example.com"
|
|
118
|
+
}
|
|
119
|
+
-----
|
|
120
|
+
|
|
121
|
+
ECS enabled
|
|
122
|
+
[source,text]
|
|
123
|
+
-----
|
|
124
|
+
{
|
|
125
|
+
"sequence" => 0,
|
|
126
|
+
"@timestamp" => 2021-03-23T20:25:10.042Z,
|
|
127
|
+
"message" => "Hello World!",
|
|
128
|
+
"@version" => "1",
|
|
129
|
+
"host" => "example.com"
|
|
130
|
+
}
|
|
131
|
+
{
|
|
132
|
+
"tags" => [
|
|
133
|
+
[0] "sun"
|
|
134
|
+
],
|
|
135
|
+
"sequence" => 0,
|
|
136
|
+
"@timestamp" => 2021-03-23T20:25:10.042Z,
|
|
137
|
+
"message" => "Hello World!",
|
|
138
|
+
"@version" => "1",
|
|
139
|
+
"host" => "example.com"
|
|
140
|
+
}
|
|
141
|
+
{
|
|
142
|
+
"tags" => [
|
|
143
|
+
[0] "moon"
|
|
144
|
+
],
|
|
145
|
+
"sequence" => 0,
|
|
146
|
+
"@timestamp" => 2021-03-23T20:25:10.042Z,
|
|
147
|
+
"message" => "Hello World!",
|
|
148
|
+
"@version" => "1",
|
|
149
|
+
"host" => "example.com"
|
|
150
|
+
}
|
|
151
|
+
-----
|
|
55
152
|
|
|
56
153
|
[id="plugins-{type}s-{plugin}-common-options"]
|
|
57
|
-
include::{include_path}/{type}.asciidoc[]
|
|
154
|
+
include::{include_path}/{type}.asciidoc[]
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# encoding: utf-8
|
|
2
2
|
require "logstash/filters/base"
|
|
3
3
|
require "logstash/namespace"
|
|
4
|
+
require "logstash/plugin_mixins/ecs_compatibility_support"
|
|
4
5
|
|
|
5
6
|
# The clone filter is for duplicating events.
|
|
6
7
|
# A clone will be created for each type in the clone list.
|
|
@@ -8,23 +9,34 @@ require "logstash/namespace"
|
|
|
8
9
|
# Created events are inserted into the pipeline
|
|
9
10
|
# as normal events and will be processed by the remaining pipeline configuration
|
|
10
11
|
# starting from the filter that generated them (i.e. this plugin).
|
|
12
|
+
#
|
|
13
|
+
# ECS disabled: set the value of the root-level `type` (undefined in ECS) of each resulting event
|
|
14
|
+
# to one of the values provided in its `clones` directive.
|
|
15
|
+
# ECS enabled: add a `tags` of each resulting event to one of the values provided in its `clones` directive.
|
|
11
16
|
class LogStash::Filters::Clone < LogStash::Filters::Base
|
|
17
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1)
|
|
12
18
|
|
|
13
19
|
config_name "clone"
|
|
14
20
|
|
|
15
21
|
# A new clone will be created with the given type for each type in this list.
|
|
16
|
-
config :clones, :validate => :array, :
|
|
22
|
+
config :clones, :validate => :array, :required => true
|
|
17
23
|
|
|
18
24
|
public
|
|
25
|
+
|
|
26
|
+
def initialize(*params)
|
|
27
|
+
super
|
|
28
|
+
@enhance_clone_type_method = method( ecs_select[disabled: :set_event_type, v1: :add_event_tag] )
|
|
29
|
+
end
|
|
30
|
+
|
|
19
31
|
def register
|
|
20
|
-
|
|
32
|
+
logger.warn("The parameter 'clones' is empty, so no clones will be created.") if @clones.empty?
|
|
21
33
|
end
|
|
22
34
|
|
|
23
35
|
public
|
|
24
36
|
def filter(event)
|
|
25
37
|
@clones.each do |type|
|
|
26
38
|
clone = event.clone
|
|
27
|
-
|
|
39
|
+
@enhance_clone_type_method.(clone, type)
|
|
28
40
|
filter_matched(clone)
|
|
29
41
|
@logger.debug("Cloned event", :clone => clone, :event => event)
|
|
30
42
|
|
|
@@ -33,4 +45,16 @@ class LogStash::Filters::Clone < LogStash::Filters::Base
|
|
|
33
45
|
end
|
|
34
46
|
end
|
|
35
47
|
|
|
48
|
+
def set_event_type(event, type)
|
|
49
|
+
event.set("type", type)
|
|
50
|
+
event
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def add_event_tag(event, clone_type)
|
|
54
|
+
tags = Array(event.get("tags"))
|
|
55
|
+
tags << clone_type
|
|
56
|
+
event.set("tags", tags)
|
|
57
|
+
event
|
|
58
|
+
end
|
|
59
|
+
|
|
36
60
|
end # class LogStash::Filters::Clone
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-filter-clone'
|
|
4
|
-
s.version = '
|
|
4
|
+
s.version = '4.1.1'
|
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
|
6
|
-
s.summary = "
|
|
6
|
+
s.summary = "Duplicates events"
|
|
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"
|
|
8
8
|
s.authors = ["Elastic"]
|
|
9
9
|
s.email = 'info@elastic.co'
|
|
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
|
|
|
21
21
|
|
|
22
22
|
# Gem dependencies
|
|
23
23
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
|
24
|
-
|
|
24
|
+
s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.1'
|
|
25
25
|
s.add_development_dependency 'logstash-devutils'
|
|
26
26
|
end
|
|
27
27
|
|
data/spec/filters/clone_spec.rb
CHANGED
|
@@ -1,82 +1,123 @@
|
|
|
1
1
|
# encoding: utf-8
|
|
2
|
-
|
|
3
2
|
require "logstash/devutils/rspec/spec_helper"
|
|
4
3
|
require "logstash/filters/clone"
|
|
4
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
|
|
5
5
|
|
|
6
6
|
describe LogStash::Filters::Clone do
|
|
7
7
|
|
|
8
|
-
describe "
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
8
|
+
describe "#filter", :ecs_compatibility_support, :aggregate_failures do
|
|
9
|
+
ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
|
|
10
|
+
|
|
11
|
+
subject { described_class.new(settings) }
|
|
12
|
+
let(:event) { LogStash::Event.new(input) }
|
|
13
|
+
before(:each) do
|
|
14
|
+
allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
|
|
15
|
+
subject.register
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
describe "all defaults" do
|
|
19
|
+
let(:input) { { "message" => "hello world", "type" => "original" } }
|
|
20
|
+
let(:settings) { { "clones" => ["clone", "clone", "clone"] } }
|
|
21
|
+
|
|
22
|
+
it "should generate new clones + current event" do
|
|
23
|
+
events = [event]
|
|
24
|
+
subject.filter(event) {|e| events << e }
|
|
25
|
+
expect(events.length).to eq(4)
|
|
26
|
+
events.each_with_index do |s,i|
|
|
27
|
+
if ecs_compatibility == :disabled
|
|
28
|
+
if i == 0 # last one should be 'original'
|
|
29
|
+
expect(s.get("type")).to eq("original")
|
|
30
|
+
else
|
|
31
|
+
expect(s.get("type")).to eq("clone")
|
|
32
|
+
end
|
|
33
|
+
expect(s.get("message")).to eq("hello world")
|
|
34
|
+
else
|
|
35
|
+
expect(s.get("type")).to eq("original")
|
|
36
|
+
expect(s.get("message")).to eq("hello world")
|
|
37
|
+
expect(s.get("tags")).to include("clone") unless i == 0
|
|
38
|
+
end
|
|
39
|
+
end
|
|
17
40
|
|
|
18
|
-
sample("message" => "hello world", "type" => "original") do
|
|
19
|
-
insist { subject }.is_a? Array
|
|
20
|
-
insist { subject.length } == 4
|
|
21
|
-
subject.each_with_index do |s,i|
|
|
22
|
-
if i == 0 # last one should be 'original'
|
|
23
|
-
insist { s.get("type") } == "original"
|
|
24
|
-
else
|
|
25
|
-
insist { s.get("type")} == "clone"
|
|
26
41
|
end
|
|
27
|
-
insist { s.get("message") } == "hello world"
|
|
28
42
|
end
|
|
29
|
-
end
|
|
30
|
-
end
|
|
31
43
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
CONFIG
|
|
44
|
+
describe "Complex use" do
|
|
45
|
+
let(:settings) do
|
|
46
|
+
{ "clones" => ["nginx-access-clone1", "nginx-access-clone2"],
|
|
47
|
+
"add_tag" => ['RABBIT','NO_ES'],
|
|
48
|
+
"remove_tag" => ["TESTLOG"]
|
|
49
|
+
}
|
|
50
|
+
end
|
|
51
|
+
let(:input) { { "type" => "nginx-access", "tags" => ["TESTLOG"], "message" => "hello world" } }
|
|
42
52
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
53
|
+
it "works as expected" do
|
|
54
|
+
events = [event]
|
|
55
|
+
subject.filter(event) {|e| events << e }
|
|
56
|
+
expect(events.length).to eq(3)
|
|
46
57
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
58
|
+
if ecs_compatibility == :disabled
|
|
59
|
+
expect(events[0].get("type")).to eq("nginx-access")
|
|
60
|
+
#Initial event remains unchanged
|
|
61
|
+
expect(events[0].get("tags")).to include("TESTLOG")
|
|
62
|
+
expect(events[0].get("tags")).to_not include("RABBIT")
|
|
63
|
+
expect(events[0].get("tags")).to_not include("NO_ES")
|
|
64
|
+
#All clones go through filter_matched
|
|
65
|
+
expect(events[1].get("type")).to eq("nginx-access-clone1")
|
|
66
|
+
expect(events[1].get("tags")).to_not include("TESTLOG")
|
|
67
|
+
expect(events[1].get("tags")).to include("RABBIT")
|
|
68
|
+
expect(events[1].get("tags")).to include("NO_ES")
|
|
57
69
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
70
|
+
expect(events[2].get("type")).to eq("nginx-access-clone2")
|
|
71
|
+
expect(events[2].get("tags")).to_not include("TESTLOG")
|
|
72
|
+
expect(events[2].get("tags")).to include("RABBIT")
|
|
73
|
+
expect(events[2].get("tags")).to include("NO_ES")
|
|
74
|
+
else
|
|
75
|
+
expect(events[0].get("type")).to eq("nginx-access")
|
|
76
|
+
expect(events[0].get("tags")).to include("TESTLOG")
|
|
77
|
+
expect(events[0].get("tags")).to_not include("RABBIT")
|
|
78
|
+
expect(events[0].get("tags")).to_not include("NO_ES")
|
|
64
79
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
CONFIG
|
|
80
|
+
(1..2).each do |i|
|
|
81
|
+
expect(events[i].get("type")).to eq("nginx-access")
|
|
82
|
+
expect(events[i].get("tags")).to_not include("TESTLOG")
|
|
83
|
+
expect(events[i].get("tags")).to include("RABBIT")
|
|
84
|
+
expect(events[i].get("tags")).to include("NO_ES")
|
|
85
|
+
end
|
|
74
86
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
87
|
+
expect(events[1].get("tags")).to include("nginx-access-clone1")
|
|
88
|
+
expect(events[2].get("tags")).to include("nginx-access-clone2")
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
describe "Bug LOGSTASH-1225" do
|
|
94
|
+
### LOGSTASH-1225: Cannot clone events containing numbers.
|
|
95
|
+
let(:settings) { { "clones" => [ 'clone1' ] } }
|
|
96
|
+
let(:input) { { "type" => "bug-1225", "message" => "unused", "number" => 5 } }
|
|
80
97
|
|
|
98
|
+
it "clones events containing numbers" do
|
|
99
|
+
events = [event]
|
|
100
|
+
subject.filter(event) {|e| events << e }
|
|
101
|
+
expect(events[0].get("number")).to eq(5)
|
|
102
|
+
expect(events[1].get("number")).to eq(5)
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
81
106
|
|
|
107
|
+
describe "#register" do
|
|
108
|
+
context "when clones is an empty array" do
|
|
109
|
+
subject { described_class.new("clones" => []) }
|
|
110
|
+
it "logs a warning" do
|
|
111
|
+
expect(subject.logger).to receive(:warn)
|
|
112
|
+
expect { subject.register }.to_not raise_error
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
context "when clones is not set" do
|
|
116
|
+
subject { described_class.new }
|
|
117
|
+
it "raises an error" do
|
|
118
|
+
expect { subject.register }.to raise_error(ArgumentError)
|
|
119
|
+
end
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
end
|
|
82
123
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-filter-clone
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 4.1.1
|
|
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-04-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -30,6 +30,20 @@ dependencies:
|
|
|
30
30
|
- - "<="
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: '2.99'
|
|
33
|
+
- !ruby/object:Gem::Dependency
|
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
|
35
|
+
requirements:
|
|
36
|
+
- - "~>"
|
|
37
|
+
- !ruby/object:Gem::Version
|
|
38
|
+
version: '1.1'
|
|
39
|
+
name: logstash-mixin-ecs_compatibility_support
|
|
40
|
+
prerelease: false
|
|
41
|
+
type: :runtime
|
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - "~>"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '1.1'
|
|
33
47
|
- !ruby/object:Gem::Dependency
|
|
34
48
|
requirement: !ruby/object:Gem::Requirement
|
|
35
49
|
requirements:
|
|
@@ -44,7 +58,9 @@ dependencies:
|
|
|
44
58
|
- - ">="
|
|
45
59
|
- !ruby/object:Gem::Version
|
|
46
60
|
version: '0'
|
|
47
|
-
description: This gem is a Logstash plugin required to be installed on top of the
|
|
61
|
+
description: This gem is a Logstash plugin required to be installed on top of the
|
|
62
|
+
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
|
63
|
+
gem is not a stand-alone program
|
|
48
64
|
email: info@elastic.co
|
|
49
65
|
executables: []
|
|
50
66
|
extensions: []
|
|
@@ -82,9 +98,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
82
98
|
version: '0'
|
|
83
99
|
requirements: []
|
|
84
100
|
rubyforge_project:
|
|
85
|
-
rubygems_version: 2.
|
|
101
|
+
rubygems_version: 2.6.13
|
|
86
102
|
signing_key:
|
|
87
103
|
specification_version: 4
|
|
88
|
-
summary:
|
|
104
|
+
summary: Duplicates events
|
|
89
105
|
test_files:
|
|
90
106
|
- spec/filters/clone_spec.rb
|