logstash-filter-ruby 3.1.1 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3953d3586b1c85bdc4ada781ef86afcf993c87b4a80c36cb97a144b4899bda9
-  data.tar.gz: b158b1b5f169ad9c3a39dfb9df860a783447b1a4683d5a49e423d6ee100c7165
+  metadata.gz: ff2b98bf9fa5c8b404fb030defcdb9a1f9413b31f921d579bc42ee11e09d7fa9
+  data.tar.gz: d9b45322e9336e8cb827f298b0be7843f66468a6bd0b6592dc0fa435be6417b5
 SHA512:
-  metadata.gz: 2d9a1d424bf405afe0f34a19294b92255c9b59fbc2e06b447ffe7a23b7c375fd42955065524d5ea3df74115cbbdaf8c8fbcd97690d1c5a36e37f09793e2e5d78
-  data.tar.gz: 984aac96251467e28071ce6ce5536f23c4a47f13e45af85a06abcf8675b0fd85ea4dddf1a2b248af1970dee57c9f5e621c2638cb30de9be8a8a18dfba655657c
+  metadata.gz: 39c66c76bcfbbd84e2f171da1808565dbaede5ef9e7265aa1dca9123ab4f99f8db09c9de543ab9f6c4c232dbf4d674cc9e76697a1e95a349af0f362601cb3210
+  data.tar.gz: 8390d67f3024fc5a18a12109f0d7de2d3e38dfa8ac6e2f11a5b90b179e4ddd32f1bba9d67b1bb5f6703db483696c2573c226f36bd599a56d1ccba624af3b2886

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.1.6
+  - Add error log backtrace to inline scripts [#54](https://github.com/logstash-plugins/logstash-filter-ruby/pull/54)
+
+## 3.1.5
+  - Fixed path based scripting not calling filter\_matched [#45](https://github.com/logstash-plugins/logstash-filter-ruby/issues/45)
+
+## 3.1.4
+  - fix return of multiple events when using file based scripts #41
+
+## 3.1.3
+  - Fix documentation issues
+
+## 3.1.2
+  - 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.1.1
   - Update gemspec summary
 
@@ -29,4 +44,3 @@
  - internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
  - internal,deps: Dependency on logstash-core update to 2.0
-

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-ruby.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-ruby)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-ruby.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-ruby)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -86,7 +86,7 @@ def filter(event)
 end
 ----
 
-====== Testing the ruby script
+===== Testing the ruby script
 
 To validate the behaviour of the `filter` method you implemented,
 the Ruby filter plugin provides an inline test framework where you
@@ -124,7 +124,7 @@ end
 
 We can now test that the ruby script we're using is implemented correctly:
 
-[source]
+[source,shell]
 ----
 % bin/logstash -e "filter { ruby { path => '/etc/logstash/drop_percentage.rb' script_params => { 'drop_percentage' => 0.5 } } }" -t
 [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}}
@@ -157,7 +157,7 @@ filter plugins.
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
-	* This setting cannot be used together with `path`.
+  * This setting cannot be used together with `path`.
 
 The code to execute for every event.
 You will have an `event` variable available that is the event itself. See the <<event-api,Event API>> for more information.
@@ -175,7 +175,7 @@ Any code to execute at logstash startup-time
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
-	* This setting cannot be used together with `code`.
+  * This setting cannot be used together with `code`.
 
 The path of the ruby script file that implements the `filter` method.
 
@@ -188,5 +188,14 @@ The path of the ruby script file that implements the `filter` method.
 A key/value hash with parameters that are passed to the register method
 of your ruby script file defined in `path`.
 
+[id="plugins-{type}s-{plugin}-tag_on_exception"]
+===== `tag_on_exception`
+
+  * Value type is <<string,string>>
+  * Default value is `_rubyexception`
+
+Tag to add to events in case the ruby code (either inline or file based)
+causes an exception.
+
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/ruby.rb

@@ -23,9 +23,10 @@ require "logstash/namespace"
 # }
 #
 class LogStash::Filters::Ruby < LogStash::Filters::Base
-  require "logstash/filters/ruby/script_error"
   require "logstash/filters/ruby/script"
 
+  class ScriptError < StandardError; end
+
   config_name "ruby"
 
   # Any code to execute at logstash startup-time
@@ -44,6 +45,9 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
   # Tag to add to events that cause an exception in the script filter
   config :tag_on_exception, :type => :string, :default => "_rubyexception"
 
+  # Flag for add exception message to tag_on_exception
+  config :tag_with_exception_message, :type => :boolean, :default => false
+
   def initialize(*params)
     super(*params)
     if @path # run tests on the ruby file script
@@ -56,7 +60,7 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
   def register
     if @code && @path.nil?
       eval(@init, binding, "(ruby filter init)") if @init
-      eval("@codeblock = lambda { |event, &new_event_block| #{@code} }", binding, "(ruby filter code)")
+      eval("define_singleton_method :filter_method do |event, &new_event_block|\n #{@code} \nend", binding, "(ruby filter code)")
     elsif @path && @code.nil?
       @script.register
     else
@@ -81,24 +85,33 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
     if @code
       inline_script(event, &block)
     elsif @path
-      file_script(event)
+      file_script(event, &block)
     end
   end
 
   def inline_script(event, &block)
-    @codeblock.call(event, &block)
+    filter_method(event, &block)
     filter_matched(event)
   rescue Exception => e
-    @logger.error("Ruby exception occurred: #{e}")
+    @logger.error("Ruby exception occurred: #{e.message}",
+                  :class     => e.class.name,
+                  :backtrace => e.backtrace)
+    if @tag_with_exception_message
+      event.tag("#{@tag_on_exception}: #{e}")
+    end
     event.tag(@tag_on_exception)
   end
 
   def file_script(event)
     begin
       results = @script.execute(event)
+      filter_matched(event)
 
       self.class.check_result_events!(results)
     rescue => e
+      if @tag_with_exception_message
+        event.tag("#{@tag_on_exception}: #{e}")
+      end
       event.tag(@tag_on_exception)
       message = "Could not process event: " + e.message
       @logger.error(message, :script_path => @path,

data/logstash-filter-ruby.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ruby'
-  s.version         = '3.1.1'
+  s.version         = '3.1.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Executes arbitrary Ruby code"
   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|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-  s.add_runtime_dependency 'logstash-filter-date'
+  s.add_development_dependency 'logstash-filter-date'
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'insist'
 end
 

data/spec/filters/ruby_spec.rb

@@ -84,19 +84,17 @@ describe LogStash::Filters::Ruby do
       end
     end
 
-    describe "allow to create new event inside the ruby filter" do
-      config <<-CONFIG
-        filter {
-          ruby {
-            code => "new_event_block.call(event.clone)"
-          }
-        }
-      CONFIG
-
-      sample("message" => "hello world", "mydate" => "2014-09-23T00:00:00-0800") do
-        expect(subject).to be_a Array
-        expect(subject[0]).not_to eq(subject[1])
-        expect(subject[0].to_hash).to eq(subject[1].to_hash)
+    describe "with new event block" do
+      subject(:filter) { ::LogStash::Filters::Ruby.new('code' => 'new_event_block.call(event.clone)') }
+      before(:each) { filter.register }
+
+      it "creates new event" do
+        event = LogStash::Event.new "message" => "hello world", "mydate" => "2014-09-23T00:00:00-0800"
+        new_events = filter.multi_filter([event])
+        expect(new_events.length).to eq 2
+        expect(new_events[0]).to equal(event)
+        expect(new_events[1]).not_to eq(event)
+        expect(new_events[1].to_hash).to eq(event.to_hash)
       end
     end
 
@@ -136,6 +134,7 @@ describe LogStash::Filters::Ruby do
       end
 
       describe "filtering" do
+        let(:filter_params) { super().merge('add_field' => {'success' => 'yes' }) }
         before(:each) do
           filter.register
           filter.filter(incoming_event)
@@ -144,6 +143,10 @@ describe LogStash::Filters::Ruby do
         it "should filter data as expected" do
           expect(incoming_event.get('foo')).to eq(84)
         end
+
+        it "should apply filter_matched" do
+          expect(incoming_event.get('success')).to eq('yes')
+        end
       end
     end
 
@@ -156,5 +159,13 @@ describe LogStash::Filters::Ruby do
         end.to raise_error(LogStash::Filters::Ruby::ScriptError)
       end
     end
+
+    describe "scripts with failing test suites" do
+      let(:script_filename) { 'multi_events.rb' }
+
+      it "should produce more multiple events" do
+        expect {|b| filter.filter(incoming_event, &b) }.to yield_control.exactly(3).times
+      end
+    end
   end
 end

data/spec/fixtures/multi_events.rb

@@ -0,0 +1,6 @@
+def register(params)
+end
+
+def filter(event)
+  [event.clone, event.clone, event.clone]
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require "insist"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
         version: '0'
   name: logstash-filter-date
   prerelease: false
-  type: :runtime
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: insist
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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
@@ -79,11 +93,11 @@ files:
 - lib/logstash/filters/ruby/script/execution_context.rb
 - lib/logstash/filters/ruby/script/expect_context.rb
 - lib/logstash/filters/ruby/script/test_context.rb
-- lib/logstash/filters/ruby/script_error.rb
 - logstash-filter-ruby.gemspec
 - spec/filters/ruby_spec.rb
 - spec/fixtures/broken.rb
 - spec/fixtures/field_multiplier.rb
+- spec/fixtures/multi_events.rb
 - spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
@@ -107,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Executes arbitrary Ruby code
@@ -115,4 +129,5 @@ test_files:
 - spec/filters/ruby_spec.rb
 - spec/fixtures/broken.rb
 - spec/fixtures/field_multiplier.rb
+- spec/fixtures/multi_events.rb
 - spec/spec_helper.rb

data/lib/logstash/filters/ruby/script_error.rb

@@ -1,2 +0,0 @@
-class LogStash::Filters::Ruby::ScriptError < StandardError
-end