logstash-filter-ruby 3.1.2 → 3.1.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -1
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +40 -6
- data/lib/logstash/filters/ruby.rb +16 -3
- data/logstash-filter-ruby.gemspec +3 -2
- data/spec/filters/ruby_spec.rb +24 -13
- data/spec/fixtures/multi_events.rb +6 -0
- data/spec/spec_helper.rb +1 -0
- metadata +19 -4
- data/lib/logstash/filters/ruby/script_error.rb +0 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 26f3d96124d72bdd663e9f2c384827d3b56734f296d1abfa143d68c67d67a252
|
4
|
+
data.tar.gz: 2e9fc5e99df96271fb68f08396670af1e7ba03a053f5590f77f7e5634bf6227c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 168dfd8d904469861cf22aad44dfdb5accdb1a3b3b20e7dc238c02e15340fc667108a57935666a66d94fd0ca4b47fb535bdde4b38bc2011543ba6df47d93c5f5
|
7
|
+
data.tar.gz: 5198f9de1bff1f32e64b09877370d01fc77a2f462dc3fe803c212f73f264763db127e21fcc7d7eead8a1deb17353244fb9f4b2634893448fa5ee48d98f146488
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,18 @@
|
|
1
|
+
## 3.1.7
|
2
|
+
- [DOC] Added docs to help people avoid concurrency issues (often caused by accidentally relying on shared state with global variables, constants, or unguarded overwriting of instance variables) [#58](https://github.com/logstash-plugins/logstash-filter-ruby/issues/58)
|
3
|
+
|
4
|
+
## 3.1.6
|
5
|
+
- Add error log backtrace to inline scripts [#54](https://github.com/logstash-plugins/logstash-filter-ruby/pull/54)
|
6
|
+
|
7
|
+
## 3.1.5
|
8
|
+
- Fixed path based scripting not calling filter\_matched [#45](https://github.com/logstash-plugins/logstash-filter-ruby/issues/45)
|
9
|
+
|
10
|
+
## 3.1.4
|
11
|
+
- fix return of multiple events when using file based scripts #41
|
12
|
+
|
13
|
+
## 3.1.3
|
14
|
+
- Fix documentation issues
|
15
|
+
|
1
16
|
## 3.1.2
|
2
17
|
- Fix concurrency issues in combination with Logstash 6.x and multiple worker threads that was caused by a [JRuby issue](https://github.com/jruby/jruby/issues/4868)
|
3
18
|
|
@@ -32,4 +47,3 @@
|
|
32
47
|
- internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
|
33
48
|
instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
|
34
49
|
- internal,deps: Dependency on logstash-core update to 2.0
|
35
|
-
|
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
|
-
[![Travis Build Status](https://travis-ci.
|
3
|
+
[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-ruby.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-ruby)
|
4
4
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
@@ -24,9 +24,12 @@ Execute ruby code. This filter accepts inline ruby code or a ruby file.
|
|
24
24
|
The two options are mutually exclusive and have slightly different ways of working,
|
25
25
|
which are described below.
|
26
26
|
|
27
|
+
NOTE: This plugin's concurrency-safety depends on your code. Be sure to read up on <<plugins-{type}s-{plugin}-concurrency,how to avoid concurrency issues>>.
|
28
|
+
|
29
|
+
[id="plugins-{type}s-{plugin}-using-inline-script"]
|
27
30
|
===== Inline ruby code
|
28
31
|
|
29
|
-
To inline ruby in your filter, place all code in the `code` option. This code will be executed for every event the filter receives. You can also place ruby code in the `init` option
|
32
|
+
To add inline ruby in your filter, place all code in the `code` option. This code will be executed for every event the filter receives. You can also place ruby code in the `init` option. It will be executed only once during the plugin's register phase.
|
30
33
|
|
31
34
|
For example, to cancel 90% of events, you can do this:
|
32
35
|
[source,ruby]
|
@@ -45,9 +48,12 @@ filter {
|
|
45
48
|
}
|
46
49
|
}
|
47
50
|
|
51
|
+
NOTE: Defining methods in the <<plugins-{type}s-{plugin}-code,`code` option>> can significantly reduce throughput. Use the <<plugins-{type}s-{plugin}-init,`init` option>> instead.
|
52
|
+
|
53
|
+
[id="plugins-{type}s-{plugin}-using-script-file"]
|
48
54
|
===== Using a Ruby script file
|
49
55
|
|
50
|
-
As the inline code can become complex and hard to structure inside of a text string in `code`, it's then
|
56
|
+
As the inline code can become complex and hard to structure inside of a text string in `code`, it's then preferable to place the Ruby code in a .rb file, using the `path` option.
|
51
57
|
|
52
58
|
[source,ruby]
|
53
59
|
filter {
|
@@ -86,7 +92,7 @@ def filter(event)
|
|
86
92
|
end
|
87
93
|
----
|
88
94
|
|
89
|
-
|
95
|
+
===== Testing the ruby script
|
90
96
|
|
91
97
|
To validate the behaviour of the `filter` method you implemented,
|
92
98
|
the Ruby filter plugin provides an inline test framework where you
|
@@ -124,7 +130,7 @@ end
|
|
124
130
|
|
125
131
|
We can now test that the ruby script we're using is implemented correctly:
|
126
132
|
|
127
|
-
[source]
|
133
|
+
[source,shell]
|
128
134
|
----
|
129
135
|
% bin/logstash -e "filter { ruby { path => '/etc/logstash/drop_percentage.rb' script_params => { 'drop_percentage' => 0.5 } } }" -t
|
130
136
|
[2017-10-13T13:44:29,723][INFO ][logstash.filters.ruby.script] Test run complete {:script_path=>"/etc/logstash/drop_percentage.rb", :results=>{:passed=>1, :failed=>0, :errored=>0}}
|
@@ -132,6 +138,25 @@ Configuration OK
|
|
132
138
|
[2017-10-13T13:44:29,887][INFO ][logstash.runner ] Using config.test_and_exit mode. Config Validation Result: OK. Exiting Logstash
|
133
139
|
----
|
134
140
|
|
141
|
+
[id="plugins-{type}s-{plugin}-concurrency"]
|
142
|
+
==== Avoiding concurrency issues
|
143
|
+
|
144
|
+
When events are flowing through a pipeline with multiple workers, a single shared instance of this filter may end up processing many events _simultaneously_.
|
145
|
+
This means that your script needs to be written to avoid mutating shared state unless it is done in a thread-safe manner.
|
146
|
+
|
147
|
+
In Ruby, the name of a variable determines its scope. The following guidance may help you avoid _accidentally_ mutating shared state:
|
148
|
+
|
149
|
+
* Freely use Local Variables, whose name begins with a lower-case letter or an underscore (`_`).
|
150
|
+
** Local Variables are available only to the individual event being processed, and are automatically cleaned up.
|
151
|
+
* Exercise caution when _modifying_ Instance Variables, whose names begin with `@` followed by a lower-case letter or an underscore (`_`).
|
152
|
+
** Instance Variables are shared between _all_ worker threads in this pipeline, which may be processing multiple events simultaneously.
|
153
|
+
** It is safe to _set_ Instance Variables in a <<plugins-{type}s-{plugin}-using-script-file,script>>-defined `register` function or with <<plugins-{type}s-{plugin}-init>>, but they should not be modified while processing events unless safe-guarded by mutual exclusion.
|
154
|
+
** Instance Variables are _not_ persisted across pipeline restarts or plugin crashes.
|
155
|
+
* _Avoid_ using variables whose scope is not limited to the plugin instance, as they can cause hard-to-debug problems that span beyond the individual plugin or pipeline:
|
156
|
+
** Class Variables: begin with `@@`.
|
157
|
+
** Global Variables: begin with a `$`.
|
158
|
+
** Constants: begin with a capital letter.
|
159
|
+
|
135
160
|
[id="plugins-{type}s-{plugin}-options"]
|
136
161
|
==== Ruby Filter Configuration Options
|
137
162
|
|
@@ -157,7 +182,7 @@ filter plugins.
|
|
157
182
|
|
158
183
|
* Value type is <<string,string>>
|
159
184
|
* There is no default value for this setting.
|
160
|
-
|
185
|
+
* This setting cannot be used together with `path`.
|
161
186
|
|
162
187
|
The code to execute for every event.
|
163
188
|
You will have an `event` variable available that is the event itself. See the <<event-api,Event API>> for more information.
|
@@ -175,7 +200,7 @@ Any code to execute at logstash startup-time
|
|
175
200
|
|
176
201
|
* Value type is <<string,string>>
|
177
202
|
* There is no default value for this setting.
|
178
|
-
|
203
|
+
* This setting cannot be used together with `code`.
|
179
204
|
|
180
205
|
The path of the ruby script file that implements the `filter` method.
|
181
206
|
|
@@ -188,5 +213,14 @@ The path of the ruby script file that implements the `filter` method.
|
|
188
213
|
A key/value hash with parameters that are passed to the register method
|
189
214
|
of your ruby script file defined in `path`.
|
190
215
|
|
216
|
+
[id="plugins-{type}s-{plugin}-tag_on_exception"]
|
217
|
+
===== `tag_on_exception`
|
218
|
+
|
219
|
+
* Value type is <<string,string>>
|
220
|
+
* Default value is `_rubyexception`
|
221
|
+
|
222
|
+
Tag to add to events in case the ruby code (either inline or file based)
|
223
|
+
causes an exception.
|
224
|
+
|
191
225
|
[id="plugins-{type}s-{plugin}-common-options"]
|
192
226
|
include::{include_path}/{type}.asciidoc[]
|
@@ -23,9 +23,10 @@ require "logstash/namespace"
|
|
23
23
|
# }
|
24
24
|
#
|
25
25
|
class LogStash::Filters::Ruby < LogStash::Filters::Base
|
26
|
-
require "logstash/filters/ruby/script_error"
|
27
26
|
require "logstash/filters/ruby/script"
|
28
27
|
|
28
|
+
class ScriptError < StandardError; end
|
29
|
+
|
29
30
|
config_name "ruby"
|
30
31
|
|
31
32
|
# Any code to execute at logstash startup-time
|
@@ -44,6 +45,9 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
|
|
44
45
|
# Tag to add to events that cause an exception in the script filter
|
45
46
|
config :tag_on_exception, :type => :string, :default => "_rubyexception"
|
46
47
|
|
48
|
+
# Flag for add exception message to tag_on_exception
|
49
|
+
config :tag_with_exception_message, :type => :boolean, :default => false
|
50
|
+
|
47
51
|
def initialize(*params)
|
48
52
|
super(*params)
|
49
53
|
if @path # run tests on the ruby file script
|
@@ -81,7 +85,7 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
|
|
81
85
|
if @code
|
82
86
|
inline_script(event, &block)
|
83
87
|
elsif @path
|
84
|
-
file_script(event)
|
88
|
+
file_script(event, &block)
|
85
89
|
end
|
86
90
|
end
|
87
91
|
|
@@ -89,16 +93,25 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
|
|
89
93
|
filter_method(event, &block)
|
90
94
|
filter_matched(event)
|
91
95
|
rescue Exception => e
|
92
|
-
@logger.error("Ruby exception occurred: #{e}"
|
96
|
+
@logger.error("Ruby exception occurred: #{e.message}",
|
97
|
+
:class => e.class.name,
|
98
|
+
:backtrace => e.backtrace)
|
99
|
+
if @tag_with_exception_message
|
100
|
+
event.tag("#{@tag_on_exception}: #{e}")
|
101
|
+
end
|
93
102
|
event.tag(@tag_on_exception)
|
94
103
|
end
|
95
104
|
|
96
105
|
def file_script(event)
|
97
106
|
begin
|
98
107
|
results = @script.execute(event)
|
108
|
+
filter_matched(event)
|
99
109
|
|
100
110
|
self.class.check_result_events!(results)
|
101
111
|
rescue => e
|
112
|
+
if @tag_with_exception_message
|
113
|
+
event.tag("#{@tag_on_exception}: #{e}")
|
114
|
+
end
|
102
115
|
event.tag(@tag_on_exception)
|
103
116
|
message = "Could not process event: " + e.message
|
104
117
|
@logger.error(message, :script_path => @path,
|
@@ -1,7 +1,7 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-filter-ruby'
|
4
|
-
s.version = '3.1.
|
4
|
+
s.version = '3.1.7'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "Executes arbitrary Ruby code"
|
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"
|
@@ -21,7 +21,8 @@ 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
|
-
s.
|
24
|
+
s.add_development_dependency 'logstash-filter-date'
|
25
25
|
s.add_development_dependency 'logstash-devutils'
|
26
|
+
s.add_development_dependency 'insist'
|
26
27
|
end
|
27
28
|
|
data/spec/filters/ruby_spec.rb
CHANGED
@@ -84,19 +84,17 @@ describe LogStash::Filters::Ruby do
|
|
84
84
|
end
|
85
85
|
end
|
86
86
|
|
87
|
-
describe "
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
expect(
|
98
|
-
expect(subject[0]).not_to eq(subject[1])
|
99
|
-
expect(subject[0].to_hash).to eq(subject[1].to_hash)
|
87
|
+
describe "with new event block" do
|
88
|
+
subject(:filter) { ::LogStash::Filters::Ruby.new('code' => 'new_event_block.call(event.clone)') }
|
89
|
+
before(:each) { filter.register }
|
90
|
+
|
91
|
+
it "creates new event" do
|
92
|
+
event = LogStash::Event.new "message" => "hello world", "mydate" => "2014-09-23T00:00:00-0800"
|
93
|
+
new_events = filter.multi_filter([event])
|
94
|
+
expect(new_events.length).to eq 2
|
95
|
+
expect(new_events[0]).to equal(event)
|
96
|
+
expect(new_events[1]).not_to eq(event)
|
97
|
+
expect(new_events[1].to_hash).to eq(event.to_hash)
|
100
98
|
end
|
101
99
|
end
|
102
100
|
|
@@ -136,6 +134,7 @@ describe LogStash::Filters::Ruby do
|
|
136
134
|
end
|
137
135
|
|
138
136
|
describe "filtering" do
|
137
|
+
let(:filter_params) { super().merge('add_field' => {'success' => 'yes' }) }
|
139
138
|
before(:each) do
|
140
139
|
filter.register
|
141
140
|
filter.filter(incoming_event)
|
@@ -144,6 +143,10 @@ describe LogStash::Filters::Ruby do
|
|
144
143
|
it "should filter data as expected" do
|
145
144
|
expect(incoming_event.get('foo')).to eq(84)
|
146
145
|
end
|
146
|
+
|
147
|
+
it "should apply filter_matched" do
|
148
|
+
expect(incoming_event.get('success')).to eq('yes')
|
149
|
+
end
|
147
150
|
end
|
148
151
|
end
|
149
152
|
|
@@ -156,5 +159,13 @@ describe LogStash::Filters::Ruby do
|
|
156
159
|
end.to raise_error(LogStash::Filters::Ruby::ScriptError)
|
157
160
|
end
|
158
161
|
end
|
162
|
+
|
163
|
+
describe "scripts with failing test suites" do
|
164
|
+
let(:script_filename) { 'multi_events.rb' }
|
165
|
+
|
166
|
+
it "should produce more multiple events" do
|
167
|
+
expect {|b| filter.filter(incoming_event, &b) }.to yield_control.exactly(3).times
|
168
|
+
end
|
169
|
+
end
|
159
170
|
end
|
160
171
|
end
|
data/spec/spec_helper.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-filter-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.1.
|
4
|
+
version: 3.1.7
|
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-05-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -38,7 +38,7 @@ dependencies:
|
|
38
38
|
version: '0'
|
39
39
|
name: logstash-filter-date
|
40
40
|
prerelease: false
|
41
|
-
type: :
|
41
|
+
type: :development
|
42
42
|
version_requirements: !ruby/object:Gem::Requirement
|
43
43
|
requirements:
|
44
44
|
- - ">="
|
@@ -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: insist
|
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
|
description: This gem is a Logstash plugin required to be installed on top of the
|
62
76
|
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
63
77
|
gem is not a stand-alone program
|
@@ -79,11 +93,11 @@ files:
|
|
79
93
|
- lib/logstash/filters/ruby/script/execution_context.rb
|
80
94
|
- lib/logstash/filters/ruby/script/expect_context.rb
|
81
95
|
- lib/logstash/filters/ruby/script/test_context.rb
|
82
|
-
- lib/logstash/filters/ruby/script_error.rb
|
83
96
|
- logstash-filter-ruby.gemspec
|
84
97
|
- spec/filters/ruby_spec.rb
|
85
98
|
- spec/fixtures/broken.rb
|
86
99
|
- spec/fixtures/field_multiplier.rb
|
100
|
+
- spec/fixtures/multi_events.rb
|
87
101
|
- spec/spec_helper.rb
|
88
102
|
homepage: http://www.elastic.co/guide/en/logstash/current/index.html
|
89
103
|
licenses:
|
@@ -115,4 +129,5 @@ test_files:
|
|
115
129
|
- spec/filters/ruby_spec.rb
|
116
130
|
- spec/fixtures/broken.rb
|
117
131
|
- spec/fixtures/field_multiplier.rb
|
132
|
+
- spec/fixtures/multi_events.rb
|
118
133
|
- spec/spec_helper.rb
|