logstash-integration-jdbc 5.1.3 → 5.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629c09f028a534cb970327b8d98eb85d8ae0371f4e9c7ccc8c5c9194d2942293
-  data.tar.gz: 9fddcb34b38b9be0bdc80cfc9c9385dacbcb821530be8c78c21024414b70f0ba
+  metadata.gz: 631bf72cc9e0bb40840f5e7537919e0501a766ddc020a970508004dbebe19d9e
+  data.tar.gz: d712fc0933239f37b56c88b3cfb7de121452ea07901ed7a17ce6339b0f351fc5
 SHA512:
-  metadata.gz: 06f23b86b0f5f15bb5c0b93cca5068199df24e9867e891d72d930dd87c7f9faf891a2d0937f55d92e74a3769b432f87c5559e07cc028bbc64652631d927f4ebb
-  data.tar.gz: 969df6533a1c1afcd01ff89283195cde0865ee72bae75ed77e9ef7abfb129af9eb62b485d5a0d293189d5348df71b546dd911146d9e46ea0b481369b938959ca
+  metadata.gz: 304d561709459feb36273bfb95cfb8dcc50aa86f2fe39d9f0af7153cdef5dbdbe91c934d8bf5c015f2c7b16ccba679042e8713f6460101b626bce79c7d2d1d3a
+  data.tar.gz: 220f00788a142ec81d5b00b0fd370ae15a02709553a28679351e04d1551252c080f2a6f62a11d1a61fe832f2e77ca0259d31b570834242277d18a09670ee38c3

data/CHANGELOG.md

@@ -1,9 +1,23 @@
+## 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/docs/filter-jdbc_static.asciidoc

@@ -264,8 +264,17 @@ order is in place.
 ===============================
 
 
+[id="plugins-{type}s-{plugin}-ecs"]
+==== Compatibility with the Elastic Common Schema (ECS)
+
+This plugin is compatible with the {ecs-ref}[Elastic Common Schema (ECS)]. 
+It behaves the same regardless of ECS compatibility, except giving a warning when ECS is enabled and `target` isn't set.
+
+TIP: Set the `target` option to avoid potential schema conflicts.
+
+
 [id="plugins-{type}s-{plugin}-options"]
-==== Jdbc_static Filter Configuration Options
+==== Jdbc_static filter configuration options
 
 This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
 

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/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.1.3'
+  s.version         = '5.1.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"
@@ -36,8 +36,9 @@ 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'

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
@@ -1619,4 +1620,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.3
+  version: 5.1.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-10-28 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:
@@ -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