logstash-filter-ruby 3.1.7 → 3.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26f3d96124d72bdd663e9f2c384827d3b56734f296d1abfa143d68c67d67a252
-  data.tar.gz: 2e9fc5e99df96271fb68f08396670af1e7ba03a053f5590f77f7e5634bf6227c
+  metadata.gz: 6f33c650c3c536720f848a957acc9aaee1015385d4c3cc8eb3ae9f5fc59e7842
+  data.tar.gz: 375254e8581ed78bd65355e93d7368ca76fe5e0747655c07e05ef723d04ece0a
 SHA512:
-  metadata.gz: 168dfd8d904469861cf22aad44dfdb5accdb1a3b3b20e7dc238c02e15340fc667108a57935666a66d94fd0ca4b47fb535bdde4b38bc2011543ba6df47d93c5f5
-  data.tar.gz: 5198f9de1bff1f32e64b09877370d01fc77a2f462dc3fe803c212f73f264763db127e21fcc7d7eead8a1deb17353244fb9f4b2634893448fa5ee48d98f146488
+  metadata.gz: 96b0535eef97e34451c4f0e8c3ee328b6276b541dfaa8bb36e21e5960c7615fcdac40dcacb75c8fd601022e7b783ebce4f87155a5741c3a37a44c7c362eb71e4
+  data.tar.gz: d4a50930afb1859269c9c36c6ccb6022bbdb0f813386373da092f1ec8541d952aec262977183a4a210e4ac3e91da007189e2a4188693a24a11fd57a3ab8ab3f5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.1.8
+ - [DOC] Added doc to describe the option `tag_with_exception_message`[#62](https://github.com/logstash-plugins/logstash-filter-ruby/pull/62)
+ - Fix SyntaxError handling so other pipelines can shut down gracefully [#64](https://github.com/logstash-plugins/logstash-filter-ruby/pull/64)
+
 ## 3.1.7
   - [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)
 

data/docs/index.asciidoc

@@ -170,6 +170,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-script_params>> |<<hash,hash>>,{}|No
 | <<plugins-{type}s-{plugin}-tag_on_exception>> |<<string,string>>,_rubyexception|No
+| <<plugins-{type}s-{plugin}-tag_with_exception_message>> |<<boolean,boolean>>,_false|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -222,5 +223,15 @@ of your ruby script file defined in `path`.
 Tag to add to events in case the ruby code (either inline or file based)
 causes an exception.
 
+[id="plugins-{type}s-{plugin}-tag_with_exception_message"]
+===== `tag_with_exception_message`
+
+* Value type is <<boolean,boolean>>
+* Default value is `false`
+
+If `true` adds a tag to the event that is the concatenation of `tag_with_exception_message`
+and the exception message.
+
+
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/ruby.rb

@@ -66,6 +66,9 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
     else
       @logger.fatal("You must either use an inline script with the \"code\" option or a script file using \"path\".")
     end
+  rescue ::ScriptError => e # SyntaxError, LoadError etc.
+    @logger.error("error in register", message: e.message, exception: e.class, backtrace: e.backtrace)
+    fail("unexpected error: #{e}")
   end
 
   def self.check_result_events!(results)

data/logstash-filter-ruby.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ruby'
-  s.version         = '3.1.7'
+  s.version         = '3.1.8'
   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"

data/spec/filters/ruby_spec.rb

@@ -29,7 +29,7 @@ describe LogStash::Filters::Ruby do
         # pretty json contains \n
         insist { subject.get("pretty").count("\n") } == 5
         # usage of JSON.parse here is to avoid parser-specific order assertions
-        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}")
+        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}")
       end
     end
 
@@ -56,7 +56,7 @@ describe LogStash::Filters::Ruby do
         # non-pretty json does not contain \n
         insist { subject.get("pretty").count("\n") } == 0
         # usage of JSON.parse here is to avoid parser-specific order assertions
-        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\"}")
+        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")}\"}")
       end
     end
 

data/spec/spec_helper.rb

@@ -1,3 +1,13 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
 require "insist"
+
+module TestHelper
+  def get_logstash_timestamp(expected)
+    LogStash::Timestamp.new(expected).to_s
+  end
+end
+
+RSpec.configure do |config|
+  config.include TestHelper
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.7
+  version: 3.1.8
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Executes arbitrary Ruby code