logstash-integration-jdbc 5.1.4 → 5.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624847dd498ef4c1cabb3623b33d6caae518d482b5e6cdab4d7aa97f79e9a0bf
-  data.tar.gz: 7fc2d7f3ebb36aa50db73c074c2f3b183f7378089a35d49bf9e581617c765cb7
+  metadata.gz: 70e445fd000df9ba4c631d3574d67826aaafcb22bb2b4c00f9e30aa386415ed0
+  data.tar.gz: 2fc2cef288fa7fa2f342db6096e79e49617c012e5ce9f5c4a5d94cc1f79b0838
 SHA512:
-  metadata.gz: d8d468fe9bd6c8d54f2aaffb17088bdc957d104e55c7b456f44afb8a581fe82dd7494ac18b768af575a95d634dc887615035be0f4a3a68261394a20254db47e6
-  data.tar.gz: b252ac776f43ea2d2a3db414d5e787fc1e8f480aeeaf73f81513ecee8c207851d7d557a9fa7878c1a9db6105891b05056f47ead3d7dddd23f49eedfcdd3a8497
+  metadata.gz: e9fd72a1ebd12db838330101716032fbe125a9dab866bd552e61eeca37d51222f1f22e29cb8cdcc1b27bba8d1e5b59e8ff22de6aba29587e3811543a23860e79
+  data.tar.gz: ae0322899fdbc65f3be931f1e2fbc2cbb82ac7d3e9980c1aa1a404085a0d4e7218944567e4750260fd638506e6f43dceb6a477c4762fe856d3c262e152988920

data/CHANGELOG.md

@@ -1,12 +1,26 @@
+## 5.1.8
+  - Fix the blocking pipeline reload and shutdown when connectivity issues happen [#85](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/85)
+
+## 5.1.7
+  - Normalize jdbc_driver_class loading to support any top-level java packages [#86](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/86)
+
+## 5.1.6
+  - Fix, serialize the JDBC driver loading steps to avoid concurrency issues [#84](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/84)
+
+## 5.1.5
+  - Refined ECS support [#82](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/82)
+    - Uses shared `target` guidance when ECS compatibility is enabled
+    - Uses Logstash's EventFactory instead of instantiating events directly
+
 ## 5.1.4
   - [DOC] Update filter-jdbc_static doc to describe ECS compatibility [#79](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/79)
 
 ## 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)
+    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)
+  -  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)
 
 ## 5.1.1
   - [DOC] Changed docs to indicate that logstash-jdbc-static requires local_table [#56](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/56). Fixes [#55](https://github.com/logstash-plugins/logstash-integration-jdbc/issues/55).

data/lib/logstash/inputs/jdbc.rb

@@ -4,8 +4,11 @@ require "logstash/namespace"
 require "logstash/plugin_mixins/jdbc/common"
 require "logstash/plugin_mixins/jdbc/jdbc"
 require "logstash/plugin_mixins/ecs_compatibility_support"
+require "logstash/plugin_mixins/ecs_compatibility_support/target_check"
 require "logstash/plugin_mixins/validator_support/field_reference_validation_adapter"
 
+require "logstash/plugin_mixins/event_support/event_factory_adapter"
+
 # this require_relative returns early unless the JRuby version is between 9.2.0.0 and 9.2.8.0
 require_relative "tzinfo_jruby_patch"
 
@@ -131,8 +134,14 @@ require_relative "tzinfo_jruby_patch"
 module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
   include LogStash::PluginMixins::Jdbc::Common
   include LogStash::PluginMixins::Jdbc::Jdbc
+
   # adds ecs_compatibility config which could be :disabled or :v1
   include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled,:v1,:v8 => :v1)
+  include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
+
+  # adds `event_factory` and `targeted_event_factory
+  include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
+
   # adds :field_reference validator adapter
   extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
 
@@ -270,13 +279,6 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
         converters[encoding] = converter
       end
     end
-
-    # target must be populated if ecs_compatibility is not :disabled
-    if @target.nil? && ecs_compatibility != :disabled
-      logger.info('ECS compatibility is enabled but no ``target`` option was specified, it is recommended'\
-                  ' to set the option to avoid potential schema conflicts (if your data is ECS compliant or'\
-                  ' non-conflicting feel free to ignore this message)')
-    end
   end # def register
 
   # test injection points
@@ -335,12 +337,7 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
         ## do the necessary conversions to string elements
         row = Hash[row.map { |k, v| [k.to_s, convert(k, v)] }]
       end
-      if @target
-        event = LogStash::Event.new
-        event.set(@target, row)
-      else
-        event = LogStash::Event.new(row)
-      end
+      event = targeted_event_factory.new_event(row)
       decorate(event)
       queue << event
     end

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

@@ -4,6 +4,8 @@ module LogStash module PluginMixins module Jdbc
 
     private
 
+    DRIVERS_LOADING_LOCK = java.util.concurrent.locks.ReentrantLock.new()
+
     def complete_sequel_opts(defaults = {})
       sequel_opts = @sequel_opts.
           map { |key,val| [key.is_a?(String) ? key.to_sym : key, val] }.
@@ -22,18 +24,25 @@ module LogStash module PluginMixins module Jdbc
       require "sequel"
       require "sequel/adapters/jdbc"
 
-      load_driver_jars
+      # execute all the driver loading related duties in a serial fashion to avoid
+      # concurrency related problems with multiple pipelines and multiple drivers
+      DRIVERS_LOADING_LOCK.lock()
       begin
-        @driver_impl = Sequel::JDBC.load_driver(@jdbc_driver_class)
-      rescue Sequel::AdapterNotFound => e # Sequel::AdapterNotFound, "#{@jdbc_driver_class} not loaded"
-        # fix this !!!
-        message = if jdbc_driver_library_set?
-                    "Are you sure you've included the correct jdbc driver in :jdbc_driver_library?"
-                  else
-                    ":jdbc_driver_library is not set, are you sure you included " +
-                        "the proper driver client libraries in your classpath?"
-                  end
-        raise LogStash::PluginLoadingError, "#{e}. #{message}"
+        load_driver_jars
+        begin
+          @driver_impl = Sequel::JDBC.load_driver(normalized_driver_class)
+        rescue Sequel::AdapterNotFound => e # Sequel::AdapterNotFound, "#{@jdbc_driver_class} not loaded"
+          # fix this !!!
+          message = if jdbc_driver_library_set?
+                      "Are you sure you've included the correct jdbc driver in :jdbc_driver_library?"
+                    else
+                      ":jdbc_driver_library is not set, are you sure you included " +
+                          "the proper driver client libraries in your classpath?"
+                    end
+          raise LogStash::PluginLoadingError, "#{e}. #{message} #{e.backtrace}"
+        end
+      ensure
+        DRIVERS_LOADING_LOCK.unlock()
       end
     end
 
@@ -62,5 +71,16 @@ module LogStash module PluginMixins module Jdbc
       !@jdbc_driver_library.nil? && !@jdbc_driver_library.empty?
     end
 
+    # normalizing the class name to always have a Java:: prefix
+    # is helpful since JRuby is only able to directly load class names
+    # whose top-level package is com, org, java, javax
+    # There are many jdbc drivers that use cc, io, net, etc.
+    def normalized_driver_class
+      if @jdbc_driver_class.start_with?("Java::", "Java.")
+        @jdbc_driver_class
+      else
+        "Java::#{@jdbc_driver_class}"
+      end
+    end
   end
 end end end

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

@@ -168,8 +168,6 @@ module LogStash  module PluginMixins module Jdbc
         @logger.warn("Failed test_connection with java.sql.SQLException.", :exception => e)
       rescue Sequel::DatabaseConnectionError => e
         @logger.warn("Failed test_connection.", :exception => e)
-        close_jdbc_connection
-
         #TODO return false and let the plugin raise a LogStash::ConfigurationError
         raise e
       end
@@ -208,9 +206,9 @@ module LogStash  module PluginMixins module Jdbc
     public
     def execute_statement
       success = false
-      @connection_lock.lock
-      open_jdbc_connection
       begin
+        @connection_lock.lock
+        open_jdbc_connection
         sql_last_value = @use_column_value ? @value_tracker.value : Time.now.utc
         @tracking_column_warning_sent = false
         @statement_handler.perform_query(@database, @value_tracker.value, @jdbc_paging_enabled, @jdbc_page_size) do |row|

data/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.1.4'
+  s.version         = '5.1.8'
   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"
@@ -36,11 +36,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'tzinfo-data'
   # 3.5 limitation is required for jdbc-static loading schedule
   s.add_runtime_dependency 'rufus-scheduler', '< 3.5'
-  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.2'
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.3'
   s.add_runtime_dependency "logstash-mixin-validator_support", '~> 1.0'
+  s.add_runtime_dependency "logstash-mixin-event_support", '~> 1.0'
 
   s.add_development_dependency "childprocess"
-  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-devutils', '>= 2.3'
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'jdbc-derby'
 end

data/spec/inputs/integration/integ_spec.rb

@@ -66,13 +66,13 @@ describe LogStash::Inputs::Jdbc, :integration => true do
       )
     end
 
-    it "should not register correctly" do
+    it "log warning msg when plugin run" do
       plugin.register
-      allow( plugin ).to receive(:log_java_exception)
+      expect( plugin ).to receive(:log_java_exception)
+      expect(plugin.logger).to receive(:warn).once.with("Exception when executing JDBC query",
+                                                        hash_including(:exception => instance_of(String)))
       q = Queue.new
-      expect do
-        plugin.run(q)
-      end.to raise_error(::Sequel::DatabaseConnectionError)
+      expect{ plugin.run(q) }.not_to raise_error
     end
 
     it "should log (native) Java driver error" do
@@ -85,9 +85,7 @@ describe LogStash::Inputs::Jdbc, :integration => true do
         logger
       end
       q = Queue.new
-      expect do
-        plugin.run(q)
-      end.to raise_error(::Sequel::DatabaseConnectionError)
+      expect{ plugin.run(q) }.not_to raise_error
     end
   end
 end

data/spec/inputs/jdbc_spec.rb

@@ -14,10 +14,11 @@ require "date"
 
 describe LogStash::Inputs::Jdbc do
   let(:connection_string) { "jdbc:derby:memory:testdb;create=true" }
+  let(:jdbc_driver_class) { "org.apache.derby.jdbc.EmbeddedDriver" }
   let(:mixin_settings) do
     {
         "jdbc_user" => ENV['USER'],
-        "jdbc_driver_class" => "org.apache.derby.jdbc.EmbeddedDriver",
+        "jdbc_driver_class" => jdbc_driver_class,
         "jdbc_connection_string" => connection_string
     }
   end
@@ -364,7 +365,7 @@ describe LogStash::Inputs::Jdbc do
     end
 
     it "should log a warn of missed target usage" do
-      expect(plugin.logger).to receive(:info).once.with(/ECS compatibility is enabled but no .*?target.*? was specified/)
+      expect(plugin.logger).to receive(:info).once.with(a_string_including("ECS compatibility is enabled").and(including("target")))
 
       plugin.register
     end
@@ -1392,10 +1393,8 @@ describe LogStash::Inputs::Jdbc do
       event = queue.pop
       expect(event.get("num")).to eq(1)
       expect(event.get("string")).to eq("A test")
-      expect(event.get("started_at")).to be_a(LogStash::Timestamp)
-      expect(event.get("started_at").to_s).to eq("1999-12-31T00:00:00.000Z")
-      expect(event.get("custom_time")).to be_a(LogStash::Timestamp)
-      expect(event.get("custom_time").to_s).to eq("1999-12-31T23:59:59.000Z")
+      expect(event.get("started_at")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T00:00:00.000Z")
+      expect(event.get("custom_time")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T23:59:59.000Z")
       expect(event.get("ranking").to_f).to eq(95.67)
     end
   end
@@ -1441,10 +1440,8 @@ describe LogStash::Inputs::Jdbc do
         event = queue.pop
         expect(event.get("num")).to eq(1)
         expect(event.get("string")).to eq("A test")
-        expect(event.get("started_at")).to be_a(LogStash::Timestamp)
-        expect(event.get("started_at").to_s).to eq("1999-12-31T00:00:00.000Z")
-        expect(event.get("custom_time")).to be_a(LogStash::Timestamp)
-        expect(event.get("custom_time").to_s).to eq("1999-12-31T23:59:59.000Z")
+        expect(event.get("started_at")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T00:00:00.000Z")
+        expect(event.get("custom_time")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T23:59:59.000Z")
         expect(event.get("ranking").to_f).to eq(95.67)
       end
     end
@@ -1619,4 +1616,21 @@ describe LogStash::Inputs::Jdbc do
       end
     end
   end
+
+  describe "jdbc_driver_class" do
+    context "when not prefixed with Java::" do
+      let(:jdbc_driver_class) { "org.apache.derby.jdbc.EmbeddedDriver" }
+      it "loads the class prefixed with Java::" do
+        expect(Sequel::JDBC).to receive(:load_driver).with(/^Java::/)
+        plugin.send(:load_driver)
+      end
+    end
+    context "when prefixed with Java::" do
+      let(:jdbc_driver_class) { "Java::org.apache.derby.jdbc.EmbeddedDriver" }
+      it "loads the class as-is" do
+        expect(Sequel::JDBC).to receive(:load_driver).with(jdbc_driver_class)
+        plugin.send(:load_driver)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.1.4
+  version: 5.1.8
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   name: logstash-mixin-ecs_compatibility_support
   prerelease: false
   type: :runtime
@@ -155,7 +155,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -170,6 +170,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-mixin-event_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -189,7 +203,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   name: logstash-devutils
   prerelease: false
   type: :development
@@ -197,7 +211,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -318,8 +332,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: Integration with JDBC - input and filter plugins