logstash-integration-jdbc 5.0.6 → 5.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd1883c21c6bbe0cdfb87cf641cc106d59cb5e4b43b9a7c7de547d9e1ff263f4
-  data.tar.gz: 749710ce22a5c81ce8bb3b024803a2075052cd21aff5870ade488b7ae4dddef7
+  metadata.gz: 07f4d0662b489114358564f9c857f22de3dab11f0210eae7ef95ef4117b7dad7
+  data.tar.gz: aa469bddf21e83acee4144b3d257099de0038b221ffa4914624c0421b1d6e17d
 SHA512:
-  metadata.gz: 0c3b0320dc3dfab3381fb2a62642e37e99445178f8d569e3f63dc0d1c83a4f4959398e4ca87163328380d28d389388bf5741a8dcbffd0a7897c151d518871690
-  data.tar.gz: 77961a244d1fbfd0c9d5cf0049eb868fdd423869828733fc1a8e76cdede5f8d9bc9731ecf7668691aa0fbdbc805a5864a035cacb2c834c43a9eb6b594460f72c
+  metadata.gz: 91f9242f4d6d425272b5737491e519fd91c6757a8e5174a519192cc7871c13ecacb6b49e4874524aff3fafaacf509bf2824feb4a733242fd08700d8af74a17d6
+  data.tar.gz: fa2d734620f5147ed32841b0ad75fa4ff30905ea3f5af1ff1da78204c6ea9455192d5bde197f5d860e2e658a4d6a003c42180bc4bfa8fb5999cef8c0d6da2240

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 5.0.7
+  - Feat: try hard to log Java cause (chain) [#62](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/62)
+
+    This allows seeing a full trace from the JDBC driver in case of connection errors. 
+
+  - Refactored Lookup used in jdbc_streaming and jdbc_static to avoid code duplication. [#59](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/59)
+
 ## 5.0.6
   - DOC:Replaced plugin_header file with plugin_header-integration file. [#40](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/40)
 

data/README.md

@@ -2,7 +2,7 @@
 Logstash Integration Plugin for JDBC, including Logstash Input and Filter Plugins
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-integration-jdbc.svg)](https://travis-ci.org/logstash-plugins/logstash-integration-jdbc)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-integration-jdbc.svg)](https://travis-ci.com/logstash-plugins/logstash-integration-jdbc)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

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

@@ -66,6 +66,7 @@ module LogStash module Filters module Jdbc
       @prepared_statement = nil
       @symbol_parameters = nil
       parse_options
+      @load_method_ref = method(:load_data_from_local)
     end
 
     def id_used_as_target?
@@ -81,11 +82,7 @@ module LogStash module Filters module Jdbc
     end
 
     def enhance(local, event)
-      if @prepared_statement
-        result = call_prepared(local, event)
-      else
-        result = fetch(local, event) # should return a LookupResult
-      end
+      result = retrieve_local_data(local, event, &@load_method_ref) # return a LookupResult
       if result.failed? || result.parameters_invalid?
         tag_failure(event)
       end
@@ -112,6 +109,7 @@ module LogStash module Filters module Jdbc
       @prepared_parameters.each_with_index { |v, i| hash[:"$p#{i}"] = v }
       @prepared_param_placeholder_map = hash
       @prepared_statement = local.prepare(query, hash.keys)
+      @load_method_ref = method(:load_data_from_prepared)
     end
 
     private
@@ -128,34 +126,23 @@ module LogStash module Filters module Jdbc
       end
     end
 
-    def fetch(local, event)
-      result = LookupResult.new()
-      if @parameters_specified
-        params = prepare_parameters_from_event(event, result)
-        if result.parameters_invalid?
-          logger.warn? && logger.warn("Parameter field not found in event", :lookup_id => @id, :invalid_parameters => result.invalid_parameters)
-          return result
-        end
-      else
-        params = {}
+    def load_data_from_local(local, query, params, result)
+      local.fetch(query, params).each do |row|
+        stringified = row.inject({}){|hash,(k,v)| hash[k.to_s] = v; hash} #Stringify row keys
+        result.push(stringified)
       end
-      begin
-        logger.debug? && logger.debug("Executing Jdbc query", :lookup_id => @id, :statement => query, :parameters => params)
-        local.fetch(query, params).each do |row|
-          stringified = row.inject({}){|hash,(k,v)| hash[k.to_s] = v; hash} #Stringify row keys
-          result.push(stringified)
-        end
-      rescue ::Sequel::Error => e
-        # all sequel errors are a subclass of this, let all other standard or runtime errors bubble up
-        result.failed!
-        logger.warn? && logger.warn("Exception when executing Jdbc query", :lookup_id => @id, :exception => e.message, :backtrace => e.backtrace.take(8))
+    end
+
+    def load_data_from_prepared(_local, _query, params, result)
+      @prepared_statement.call(params).each do |row|
+        stringified = row.inject({}){|hash,(k,v)| hash[k.to_s] = v; hash} #Stringify row keys
+        result.push(stringified)
       end
-      # if either of: no records or a Sequel exception occurs the payload is
-      # empty and the default can be substituted later.
-      result
     end
 
-    def call_prepared(local, event)
+    # the &block is invoked with 4 arguments: local, query[String], params[Hash], result[LookupResult]
+    # the result is used as accumulator return variable
+    def retrieve_local_data(local, event, &proc)
       result = LookupResult.new()
       if @parameters_specified
         params = prepare_parameters_from_event(event, result)
@@ -168,10 +155,7 @@ module LogStash module Filters module Jdbc
       end
       begin
         logger.debug? && logger.debug("Executing Jdbc query", :lookup_id => @id, :statement => query, :parameters => params)
-        @prepared_statement.call(params).each do |row|
-          stringified = row.inject({}){|hash,(k,v)| hash[k.to_s] = v; hash} #Stringify row keys
-          result.push(stringified)
-        end
+        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
         result.failed!

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

@@ -122,16 +122,32 @@ module LogStash  module PluginMixins module Jdbc
         # rescue Java::JavaSql::SQLException, ::Sequel::Error => e
         rescue ::Sequel::Error => e
           if retry_attempts <= 0
-            @logger.error("Unable to connect to database. Tried #{@connection_retry_attempts} times", :error_message => e.message)
+            log_java_exception(e.cause)
+            @logger.error("Unable to connect to database. Tried #{@connection_retry_attempts} times", error_details(e, trace: true))
             raise e
           else
-            @logger.error("Unable to connect to database. Trying again", :error_message => e.message)
+            @logger.error("Unable to connect to database. Trying again", error_details(e, trace: false))
           end
         end
         sleep(@connection_retry_attempts_wait_time)
       end
     end
 
+    def error_details(e, trace: false)
+      details = { :message => e.message, :exception => e.class }
+      details[:cause] = e.cause if e.cause
+      details[:backtrace] = e.backtrace if trace || @logger.debug?
+      details
+    end
+
+    def log_java_exception(e)
+      return unless e.is_a?(java.lang.Exception)
+      # @logger.name using the same convention as LS does
+      logger = self.class.name.gsub('::', '.').downcase
+      logger = org.apache.logging.log4j.LogManager.getLogger(logger)
+      logger.error('', e) # prints nested causes
+    end
+
     def open_jdbc_connection
       # at this point driver is already loaded
       Sequel.application_timezone = @plugin_timezone.to_sym

data/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.0.6'
+  s.version         = '5.0.7'
   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/integration/jdbc_static_spec.rb

@@ -59,7 +59,7 @@ module LogStash module Filters
 
     let(:plugin) { JdbcStatic.new(settings) }
 
-    let(:event)      { ::LogStash::Event.new("message" => "some text", "ip" => ipaddr) }
+    let(:event) { ::LogStash::Event.new("message" => "some text", "ip" => ipaddr) }
 
     let(:ipaddr) { ".3.1.1" }
 

data/spec/inputs/integration/integ_spec.rb

@@ -45,7 +45,7 @@ describe LogStash::Inputs::Jdbc, :integration => true do
 
   context "when supplying a non-existent library" do
     let(:settings) do
-      super.merge(
+      super().merge(
           "jdbc_driver_library" => "/no/path/to/postgresql.jar"
       )
     end
@@ -61,13 +61,29 @@ describe LogStash::Inputs::Jdbc, :integration => true do
 
   context "when connecting to a non-existent server" do
     let(:settings) do
-      super.merge(
+      super().merge(
           "jdbc_connection_string" => "jdbc:postgresql://localhost:65000/somedb"
       )
     end
 
     it "should not register correctly" do
       plugin.register
+      allow( plugin ).to receive(:log_java_exception)
+      q = Queue.new
+      expect do
+        plugin.run(q)
+      end.to raise_error(::Sequel::DatabaseConnectionError)
+    end
+
+    it "should log (native) Java driver error" do
+      plugin.register
+      expect( org.apache.logging.log4j.LogManager ).to receive(:getLogger).and_wrap_original do |m, *args|
+        logger = m.call(*args)
+        expect( logger ).to receive(:error) do |_, e|
+          expect( e ).to be_a org.postgresql.util.PSQLException
+        end.and_call_original
+        logger
+      end
       q = Queue.new
       expect do
         plugin.run(q)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.0.6
+  version: 5.0.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement