logstash-integration-jdbc 5.1.2 → 5.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34dbd968b687896da6407942201421c91970d025814596b7229609493b8bbcdc
-  data.tar.gz: a5155f4d11413ae5440c1c3ec4da5215c3cdd6febd4cb6d6376b2a03bdcbad42
+  metadata.gz: 629c09f028a534cb970327b8d98eb85d8ae0371f4e9c7ccc8c5c9194d2942293
+  data.tar.gz: 9fddcb34b38b9be0bdc80cfc9c9385dacbcb821530be8c78c21024414b70f0ba
 SHA512:
-  metadata.gz: dec5e76bf0354e7d46fafcb56725ba581ad31c54d475269faf5562e658f3723426a14011d961d6aedaf6ba921b9a654dbe05b2707bdfad38e6b3ca34f1934b56
-  data.tar.gz: 65eb85f0e25e73f2e63de44c3d9e64ad6d834c5af316208acb445efcf1aa8d4443de00f2dcf68e66c90057a46fbddb9c7ff451b80bc46ce03bcf32b43c7a6c4a
+  metadata.gz: 06f23b86b0f5f15bb5c0b93cca5068199df24e9867e891d72d930dd87c7f9faf891a2d0937f55d92e74a3769b432f87c5559e07cc028bbc64652631d927f4ebb
+  data.tar.gz: 969df6533a1c1afcd01ff89283195cde0865ee72bae75ed77e9ef7abfb129af9eb62b485d5a0d293189d5348df71b546dd911146d9e46ea0b481369b938959ca

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.1.3
+  - Improve robustness when handling errors from `sequel` library in jdbc static and streaming
+    filters[#78](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/78)
+
 ## 5.1.2
   -  Fix `prepared_statement_bind_values` in streaming filter to resolve nested event's fields[#76](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/76)
 

data/lib/logstash/filters/jdbc/lookup.rb

@@ -162,8 +162,11 @@ module LogStash module Filters module Jdbc
       begin
         logger.debug? && logger.debug("Executing Jdbc query", :lookup_id => @id, :statement => query, :parameters => params)
         proc.call(local, query, params, result)
-      rescue ::Sequel::Error => e
-        # all sequel errors are a subclass of this, let all other standard or runtime errors bubble up
+      rescue => e
+        # In theory all exceptions in Sequel should be wrapped in Sequel::Error
+        # However, there are cases where other errors can occur - a `SQLTransactionRollbackException`
+        # may be thrown during `prepareStatement`. Let's handle these cases here, where we can tag and warn
+        # appropriately rather than bubble up and potentially crash the plugin.
         result.failed!
         logger.warn? && logger.warn("Exception when executing Jdbc query", :lookup_id => @id, :exception => e.message, :backtrace => e.backtrace.take(8))
       end

data/lib/logstash/plugin_mixins/jdbc/jdbc.rb

@@ -119,8 +119,7 @@ module LogStash  module PluginMixins module Jdbc
           else
             @logger.error("Failed to connect to database. #{@jdbc_pool_timeout} second timeout exceeded. Trying again.")
           end
-        # rescue Java::JavaSql::SQLException, ::Sequel::Error => e
-        rescue ::Sequel::Error => e
+        rescue Java::JavaSql::SQLException, ::Sequel::Error => e
           if retry_attempts <= 0
             log_java_exception(e.cause)
             @logger.error("Unable to connect to database. Tried #{@connection_retry_attempts} times", error_details(e, trace: true))

data/lib/logstash/plugin_mixins/jdbc_streaming/statement_handler.rb

@@ -38,8 +38,11 @@ module LogStash module PluginMixins module JdbcStreaming
         begin
           logger.debug? && logger.debug("Executing JDBC query", :statement => statement, :parameters => params)
           execute_extract_records(db, params, result)
-        rescue ::Sequel::Error => e
-          # all sequel errors are a subclass of this, let all other standard or runtime errors bubble up
+        rescue => e
+          # In theory all exceptions in Sequel should be wrapped in Sequel::Error
+          # However, there are cases where other errors can occur - a `SQLException`may be thrown
+          # during `prepareStatement`. Let's handle these cases here, where we can tag and warn
+          # appropriately rather than bubble up and potentially crash the plugin.
           result.failed!
           logger.warn? && logger.warn("Exception when executing JDBC query", :statement => statement, :parameters => params, :exception => e)
         end

data/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.1.2'
+  s.version         = '5.1.3'
   s.licenses = ['Apache License (2.0)']
   s.summary         = "Integration with JDBC - input and filter plugins"
   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/jdbc/lookup_spec.rb

@@ -249,6 +249,41 @@ module LogStash module Filters module Jdbc
       end
     end
 
+    describe "lookup operations when prepareStatement throws" do
+      let(:local_db) { double("local_db") }
+      let(:lookup_hash) do
+        {
+            "query" => "select * from servers WHERE ip LIKE ? AND os LIKE ?",
+            "prepared_parameters" => ["%%{[ip]}"],
+            "target" => "server",
+            "tag_on_failure" => ["_jdbcstaticfailure_server"]
+        }
+      end
+      let(:event) { LogStash::Event.new()}
+      let(:records) { [{"name" => "ldn-1-23", "rack" => "2:1:6"}] }
+      let(:prepared_statement) { double("prepared_statement")}
+
+      subject(:lookup) { described_class.new(lookup_hash, {}, "lookup-1") }
+
+      before(:each) do
+        allow(local_db).to receive(:prepare).once.and_return(prepared_statement)
+        allow(prepared_statement).to receive(:call).once.and_raise(Java::JavaSql::SQLTransactionRollbackException.new)
+      end
+
+      it "must not be valid" do
+        expect(subject.valid?).to be_falsey
+      end
+
+      it "should tag event as failed" do
+        event.set("ip", "20.20")
+        event.set("os", "MacOS")
+        subject.prepare(local_db)
+        subject.enhance(local_db, event)
+        expect(event.get("tags")).to eq(["_jdbcstaticfailure_server"])
+        expect(event.get("server")).to be_nil
+      end
+    end
+
     describe "validation of target option" do
       let(:lookup_hash) do
         {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.1.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement