logstash-filter-grok 4.1.1 → 4.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/Gemfile +6 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +66 -0
- data/lib/logstash/filters/grok.rb +158 -46
- data/logstash-filter-grok.gemspec +4 -4
- data/spec/filters/grok_performance_spec.rb +144 -0
- data/spec/filters/grok_spec.rb +629 -646
- data/spec/spec_helper.rb +19 -0
- metadata +33 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7da420422b6fab57d3744663967c3074c61527b7f3fdb21734743f86f7204cbc
|
4
|
+
data.tar.gz: 222fc8470f7baa66579e9d58caa6346e6ee14aa27119ba0fd4fbabe6c88497a7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8edfd6601703121eee96a189a3bb67153887779c4505361baf54cf12a01cb28391af8ed7a8b59bdfb873f6d9046da262a5ed22d18376379f9d87feab748a5e88
|
7
|
+
data.tar.gz: 2269f42b002e42637579d803c12fdb5a238c8904e6a36703e1c53a6e2c656b3407f8150567f355b84106613d8a1d410b665393c52db67547ca750ee4778e3e87
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,17 @@
|
|
1
|
+
## 4.4.1
|
2
|
+
- Added preview of ECS v8 support using existing ECS v1 implementation [#175](https://github.com/logstash-plugins/logstash-filter-grok/pull/175)
|
3
|
+
|
4
|
+
## 4.4.0
|
5
|
+
- Feat: ECS compatibility support [#162](https://github.com/logstash-plugins/logstash-filter-grok/pull/162)
|
6
|
+
|
7
|
+
The filter supports using built-in pattern definitions that are fully Elastic Common Schema (ECS) compliant.
|
8
|
+
|
9
|
+
## 4.3.0
|
10
|
+
- Added: added target support [#156](https://github.com/logstash-plugins/logstash-filter-grok/pull/156)
|
11
|
+
|
12
|
+
## 4.2.0
|
13
|
+
- Added: support for timeout_scope [#153](https://github.com/logstash-plugins/logstash-filter-grok/pull/153)
|
14
|
+
|
1
15
|
## 4.1.1
|
2
16
|
- Fix formatting for code sample [#148](https://github.com/logstash-plugins/logstash-filter-grok/pull/148)
|
3
17
|
|
data/Gemfile
CHANGED
@@ -9,3 +9,9 @@ if Dir.exist?(logstash_path) && use_logstash_source
|
|
9
9
|
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
10
10
|
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
11
11
|
end
|
12
|
+
|
13
|
+
group :test do
|
14
|
+
gem 'rspec-benchmark', :require => false if RUBY_VERSION >= '2.3'
|
15
|
+
gem 'logstash-input-generator', :require => false
|
16
|
+
gem 'logstash-output-null', :require => false
|
17
|
+
end
|
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-grok.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-grok)
|
4
4
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
@@ -175,6 +175,21 @@ Another option is to define patterns _inline_ in the filter using `pattern_defin
|
|
175
175
|
This is mostly for convenience and allows user to define a pattern which can be used just in that
|
176
176
|
filter. This newly defined patterns in `pattern_definitions` will not be available outside of that particular `grok` filter.
|
177
177
|
|
178
|
+
[id="plugins-{type}s-{plugin}-ecs"]
|
179
|
+
==== Migrating to Elastic Common Schema (ECS)
|
180
|
+
|
181
|
+
To ease migration to the {ecs-ref}[Elastic Common Schema (ECS)], the filter
|
182
|
+
plugin offers a new set of ECS-compliant patterns in addition to the existing
|
183
|
+
patterns. The new ECS pattern definitions capture event field names that are
|
184
|
+
compliant with the schema.
|
185
|
+
|
186
|
+
The ECS pattern set has all of the pattern definitions from the legacy set, and is
|
187
|
+
a drop-in replacement. Use the <<plugins-{type}s-{plugin}-ecs_compatibility>>
|
188
|
+
setting to switch modes.
|
189
|
+
|
190
|
+
New features and enhancements will be added to the ECS-compliant files. The
|
191
|
+
legacy patterns may still receive bug fixes which are backwards compatible.
|
192
|
+
|
178
193
|
|
179
194
|
[id="plugins-{type}s-{plugin}-options"]
|
180
195
|
==== Grok Filter Configuration Options
|
@@ -185,6 +200,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
185
200
|
|=======================================================================
|
186
201
|
|Setting |Input type|Required
|
187
202
|
| <<plugins-{type}s-{plugin}-break_on_match>> |<<boolean,boolean>>|No
|
203
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
|
188
204
|
| <<plugins-{type}s-{plugin}-keep_empty_captures>> |<<boolean,boolean>>|No
|
189
205
|
| <<plugins-{type}s-{plugin}-match>> |<<hash,hash>>|No
|
190
206
|
| <<plugins-{type}s-{plugin}-named_captures_only>> |<<boolean,boolean>>|No
|
@@ -195,6 +211,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
195
211
|
| <<plugins-{type}s-{plugin}-tag_on_failure>> |<<array,array>>|No
|
196
212
|
| <<plugins-{type}s-{plugin}-tag_on_timeout>> |<<string,string>>|No
|
197
213
|
| <<plugins-{type}s-{plugin}-timeout_millis>> |<<number,number>>|No
|
214
|
+
| <<plugins-{type}s-{plugin}-timeout_scope>> |<<string,string>>|No
|
198
215
|
|=======================================================================
|
199
216
|
|
200
217
|
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
@@ -212,6 +229,20 @@ Break on first match. The first successful match by grok will result in the
|
|
212
229
|
filter being finished. If you want grok to try all patterns (maybe you are
|
213
230
|
parsing different things), then set this to false.
|
214
231
|
|
232
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
233
|
+
===== `ecs_compatibility`
|
234
|
+
|
235
|
+
* Value type is <<string,string>>
|
236
|
+
* Supported values are:
|
237
|
+
** `disabled`: the plugin will load legacy (built-in) pattern definitions
|
238
|
+
** `v1`,`v8`: all patterns provided by the plugin will use ECS compliant captures
|
239
|
+
* Default value depends on which version of Logstash is running:
|
240
|
+
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
|
241
|
+
** Otherwise, the default value is `disabled`.
|
242
|
+
|
243
|
+
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
|
244
|
+
The value of this setting affects extracted event field names when a composite pattern (such as `HTTPD_COMMONLOG`) is matched.
|
245
|
+
|
215
246
|
[id="plugins-{type}s-{plugin}-keep_empty_captures"]
|
216
247
|
===== `keep_empty_captures`
|
217
248
|
|
@@ -282,6 +313,17 @@ overwrite the `message` field with part of the match like so:
|
|
282
313
|
In this case, a line like `May 29 16:37:11 sadness logger: hello world`
|
283
314
|
will be parsed and `hello world` will overwrite the original message.
|
284
315
|
|
316
|
+
If you are using a field reference in `overwrite`, you must use the field
|
317
|
+
reference in the pattern. Example:
|
318
|
+
[source,ruby]
|
319
|
+
filter {
|
320
|
+
grok {
|
321
|
+
match => { "somefield" => "%{NUMBER} %{GREEDYDATA:[nested][field][test]}" }
|
322
|
+
overwrite => [ "[nested][field][test]" ]
|
323
|
+
}
|
324
|
+
}
|
325
|
+
|
326
|
+
|
285
327
|
[id="plugins-{type}s-{plugin}-pattern_definitions"]
|
286
328
|
===== `pattern_definitions`
|
287
329
|
|
@@ -344,6 +386,14 @@ successful match
|
|
344
386
|
|
345
387
|
Tag to apply if a grok regexp times out.
|
346
388
|
|
389
|
+
[id="plugins-{type}s-{plugin}-target"]
|
390
|
+
===== `target`
|
391
|
+
|
392
|
+
* Value type is <<string,string>>
|
393
|
+
* There is no default value for this setting
|
394
|
+
|
395
|
+
Define target namespace for placing matches.
|
396
|
+
|
347
397
|
[id="plugins-{type}s-{plugin}-timeout_millis"]
|
348
398
|
===== `timeout_millis`
|
349
399
|
|
@@ -356,6 +406,22 @@ This will never timeout early, but may take a little longer to timeout.
|
|
356
406
|
Actual timeout is approximate based on a 250ms quantization.
|
357
407
|
Set to 0 to disable timeouts
|
358
408
|
|
409
|
+
[id="plugins-{type}s-{plugin}-timeout_scope"]
|
410
|
+
===== `timeout_scope`
|
411
|
+
|
412
|
+
* Value type is <<string,string>>
|
413
|
+
* Default value is `"pattern"`
|
414
|
+
* Supported values are `"pattern"` and `"event"`
|
415
|
+
|
416
|
+
When multiple patterns are provided to <<plugins-{type}s-{plugin}-match>>,
|
417
|
+
the timeout has historically applied to _each_ pattern, incurring overhead
|
418
|
+
for each and every pattern that is attempted; when the grok filter is
|
419
|
+
configured with `timeout_scope => event`, the plugin instead enforces
|
420
|
+
a single timeout across all attempted matches on the event, so it can
|
421
|
+
achieve similar safeguard against runaway matchers with significantly
|
422
|
+
less overhead.
|
423
|
+
|
424
|
+
It's usually better to scope the timeout for the whole event.
|
359
425
|
|
360
426
|
|
361
427
|
[id="plugins-{type}s-{plugin}-common-options"]
|