logstash-filter-ruby 3.1.4 → 3.1.8

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 271561a7f499fd9c88f66ab5e9996632fedad8b754f9736f8822733e5826c458
4
- data.tar.gz: b91749139896908ae0fd1d8dd7532a4edb2103828aaf2dba1e0756ae85a0ed56
3
+ metadata.gz: 6f33c650c3c536720f848a957acc9aaee1015385d4c3cc8eb3ae9f5fc59e7842
4
+ data.tar.gz: 375254e8581ed78bd65355e93d7368ca76fe5e0747655c07e05ef723d04ece0a
5
5
  SHA512:
6
- metadata.gz: f35bbb4dc35d24e2804fb0e443561e27fb59e4a5955dd3895bbf6341e5ef4343e78e5220b627e65d4cc9d2db63d185e10adad0374c219c1c2d0bfe16b97e2bd6
7
- data.tar.gz: dfcde101fc4f975c81e803bf4af90e77a7719932b01fe94d7953a501b1e34049d44107b2ca9860a66b596f1614387df7d6e1c8d1f0c27293338178ed626ae973
6
+ metadata.gz: 96b0535eef97e34451c4f0e8c3ee328b6276b541dfaa8bb36e21e5960c7615fcdac40dcacb75c8fd601022e7b783ebce4f87155a5741c3a37a44c7c362eb71e4
7
+ data.tar.gz: d4a50930afb1859269c9c36c6ccb6022bbdb0f813386373da092f1ec8541d952aec262977183a4a210e4ac3e91da007189e2a4188693a24a11fd57a3ab8ab3f5
data/CHANGELOG.md CHANGED
@@ -1,3 +1,16 @@
1
+ ## 3.1.8
2
+ - [DOC] Added doc to describe the option `tag_with_exception_message`[#62](https://github.com/logstash-plugins/logstash-filter-ruby/pull/62)
3
+ - Fix SyntaxError handling so other pipelines can shut down gracefully [#64](https://github.com/logstash-plugins/logstash-filter-ruby/pull/64)
4
+
5
+ ## 3.1.7
6
+ - [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)
7
+
8
+ ## 3.1.6
9
+ - Add error log backtrace to inline scripts [#54](https://github.com/logstash-plugins/logstash-filter-ruby/pull/54)
10
+
11
+ ## 3.1.5
12
+ - Fixed path based scripting not calling filter\_matched [#45](https://github.com/logstash-plugins/logstash-filter-ruby/issues/45)
13
+
1
14
  ## 3.1.4
2
15
  - fix return of multiple events when using file based scripts #41
3
16
 
@@ -38,4 +51,3 @@
38
51
  - internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
39
52
  instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
40
53
  - internal,deps: Dependency on logstash-core update to 2.0
41
-
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2020 Elastic and contributors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Logstash Plugin
2
2
 
3
- [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-ruby.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-ruby)
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 - it will be executed only once during the plugin's register phase.
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 preferrable to place the Ruby code in a .rb file, using the `path` option.
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 {
@@ -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
 
@@ -145,6 +170,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
145
170
  | <<plugins-{type}s-{plugin}-path>> |<<string,string>>|No
146
171
  | <<plugins-{type}s-{plugin}-script_params>> |<<hash,hash>>,{}|No
147
172
  | <<plugins-{type}s-{plugin}-tag_on_exception>> |<<string,string>>,_rubyexception|No
173
+ | <<plugins-{type}s-{plugin}-tag_with_exception_message>> |<<boolean,boolean>>,_false|No
148
174
  |=======================================================================
149
175
 
150
176
  Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -197,5 +223,15 @@ of your ruby script file defined in `path`.
197
223
  Tag to add to events in case the ruby code (either inline or file based)
198
224
  causes an exception.
199
225
 
226
+ [id="plugins-{type}s-{plugin}-tag_with_exception_message"]
227
+ ===== `tag_with_exception_message`
228
+
229
+ * Value type is <<boolean,boolean>>
230
+ * Default value is `false`
231
+
232
+ If `true` adds a tag to the event that is the concatenation of `tag_with_exception_message`
233
+ and the exception message.
234
+
235
+
200
236
  [id="plugins-{type}s-{plugin}-common-options"]
201
237
  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
@@ -62,6 +66,9 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
62
66
  else
63
67
  @logger.fatal("You must either use an inline script with the \"code\" option or a script file using \"path\".")
64
68
  end
69
+ rescue ::ScriptError => e # SyntaxError, LoadError etc.
70
+ @logger.error("error in register", message: e.message, exception: e.class, backtrace: e.backtrace)
71
+ fail("unexpected error: #{e}")
65
72
  end
66
73
 
67
74
  def self.check_result_events!(results)
@@ -89,16 +96,25 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
89
96
  filter_method(event, &block)
90
97
  filter_matched(event)
91
98
  rescue Exception => e
92
- @logger.error("Ruby exception occurred: #{e}")
99
+ @logger.error("Ruby exception occurred: #{e.message}",
100
+ :class => e.class.name,
101
+ :backtrace => e.backtrace)
102
+ if @tag_with_exception_message
103
+ event.tag("#{@tag_on_exception}: #{e}")
104
+ end
93
105
  event.tag(@tag_on_exception)
94
106
  end
95
107
 
96
108
  def file_script(event)
97
109
  begin
98
110
  results = @script.execute(event)
111
+ filter_matched(event)
99
112
 
100
113
  self.class.check_result_events!(results)
101
114
  rescue => e
115
+ if @tag_with_exception_message
116
+ event.tag("#{@tag_on_exception}: #{e}")
117
+ end
102
118
  event.tag(@tag_on_exception)
103
119
  message = "Could not process event: " + e.message
104
120
  @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'
4
+ s.version = '3.1.8'
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.add_runtime_dependency 'logstash-filter-date'
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
 
@@ -29,7 +29,7 @@ describe LogStash::Filters::Ruby do
29
29
  # pretty json contains \n
30
30
  insist { subject.get("pretty").count("\n") } == 5
31
31
  # usage of JSON.parse here is to avoid parser-specific order assertions
32
- insist { JSON.parse(subject.get("pretty")) } == JSON.parse("{\n \"message\": \"hello world\",\n \"mydate\": \"2014-09-23T00:00:00-0800\",\n \"@version\": \"1\",\n \"@timestamp\": \"2014-09-23T08:00:00.000Z\"\n}")
32
+ insist { JSON.parse(subject.get("pretty")) } == JSON.parse("{\n \"message\": \"hello world\",\n \"mydate\": \"2014-09-23T00:00:00-0800\",\n \"@version\": \"1\",\n \"@timestamp\": \"#{get_logstash_timestamp("2014-09-23T08:00:00.000Z")}\"\n}")
33
33
  end
34
34
  end
35
35
 
@@ -56,7 +56,7 @@ describe LogStash::Filters::Ruby do
56
56
  # non-pretty json does not contain \n
57
57
  insist { subject.get("pretty").count("\n") } == 0
58
58
  # usage of JSON.parse here is to avoid parser-specific order assertions
59
- insist { JSON.parse(subject.get("pretty")) } == JSON.parse("{\"message\":\"hello world\",\"mydate\":\"2014-09-23T00:00:00-0800\",\"@version\":\"1\",\"@timestamp\":\"2014-09-23T08:00:00.000Z\"}")
59
+ insist { JSON.parse(subject.get("pretty")) } == JSON.parse("{\"message\":\"hello world\",\"mydate\":\"2014-09-23T00:00:00-0800\",\"@version\":\"1\",\"@timestamp\":\"#{get_logstash_timestamp("2014-09-23T08:00:00.000Z")}\"}")
60
60
  end
61
61
  end
62
62
 
@@ -84,19 +84,17 @@ describe LogStash::Filters::Ruby do
84
84
  end
85
85
  end
86
86
 
87
- describe "allow to create new event inside the ruby filter" do
88
- config <<-CONFIG
89
- filter {
90
- ruby {
91
- code => "new_event_block.call(event.clone)"
92
- }
93
- }
94
- CONFIG
95
-
96
- sample("message" => "hello world", "mydate" => "2014-09-23T00:00:00-0800") do
97
- expect(subject).to be_a Array
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
 
data/spec/spec_helper.rb CHANGED
@@ -1,2 +1,13 @@
1
1
  # encoding: utf-8
2
2
  require "logstash/devutils/rspec/spec_helper"
3
+ require "insist"
4
+
5
+ module TestHelper
6
+ def get_logstash_timestamp(expected)
7
+ LogStash::Timestamp.new(expected).to_s
8
+ end
9
+ end
10
+
11
+ RSpec.configure do |config|
12
+ config.include TestHelper
13
+ end
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
4
+ version: 3.1.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-03-16 00:00:00.000000000 Z
11
+ date: 2022-01-24 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: :runtime
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,7 +93,6 @@ 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
@@ -107,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
107
120
  - !ruby/object:Gem::Version
108
121
  version: '0'
109
122
  requirements: []
110
- rubyforge_project:
111
- rubygems_version: 2.6.13
123
+ rubygems_version: 3.1.6
112
124
  signing_key:
113
125
  specification_version: 4
114
126
  summary: Executes arbitrary Ruby code
@@ -1,2 +0,0 @@
1
- class LogStash::Filters::Ruby::ScriptError < StandardError
2
- end