logstash-integration-jdbc 5.1.1 → 5.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c88894d9c18905f8b857fb38288708bce49084b62ebbffea3cac41421f33dbb
-  data.tar.gz: 32eb5bce9ba161d5c500bebe20bbd036ebeb20ba1ee149247fb8b169be790bf9
+  metadata.gz: 71904a199b39255cbefb08b1c43a08e0507df8af19be11ae3b57b69519d337f5
+  data.tar.gz: 17e4ef460ad1e9d51d0ecada1d94b6d41951a65e65f316e287ad58331f5a4211
 SHA512:
-  metadata.gz: 2c36ce3aee724b1ec82ee2ce295fd92485acf8ba97ad5428d0d55263cd72a52a9349a523c7d5b5eb76f057fdbf7e8638bd36a7f27ccf1069fa075b0b03e56717
-  data.tar.gz: 7441a532d6fbd600239c405220a0efcea6e1eb1aac421287be8b39c2119e907e611f0933e2863aaea3e90e0fb59f095dae9ebbad016fe54563dbcb9808341046
+  metadata.gz: 503737f45cfcba0724d533664b14bda25bf9abd0c5de549973857855f00722a666022693d1d22e517b735e6171a06d20cd31e11492c7d60321b3456627eab05f
+  data.tar.gz: 78d36bd182723abdc72ebf7809f76b86111d3e8bc4111bb08c5a8363fe88e8fe38c4ab563f1408f60c7b0b491f3802c69a31259e4035e8bebcd4bbfc5e8636d9

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 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)
+
+## 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)
+
 ## 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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2018 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

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/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/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/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/parameter_handler.rb

@@ -26,7 +26,7 @@ module LogStash module PluginMixins module JdbcStreaming
         return InterpolatedParameter.new(given_value)
       end
 
-      if given_value =~ /\A\s*\[[^\]]+\]\s*\z/
+      if given_value =~ /\A(\s*\[[^\]]+\]\s*)*\z/
         return FieldParameter.new(given_value)
       end
 

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.1'
+  s.version         = '5.1.5'
   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/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
         {

data/spec/inputs/jdbc_spec.rb

@@ -364,7 +364,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

data/spec/plugin_mixins/jdbc_streaming/parameter_handler_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/plugin_mixins/jdbc_streaming/parameter_handler"
+
+
+describe LogStash::PluginMixins::JdbcStreaming::ParameterHandler do
+  context "resolve field reference" do
+    let(:event) { ::LogStash::Event.new("field" => "field_value") }
+
+    it "should resolve root field" do
+      handler = LogStash::PluginMixins::JdbcStreaming::ParameterHandler.build_bind_value_handler "[field]"
+      handler.extract_from(event)
+      expect(handler.extract_from(event)).to eq "field_value"
+    end
+
+    it "should resolve nested field" do
+      event = ::LogStash::Event.from_json("{\"field\": {\"nested\": \"nested_field\"}}").first
+      handler = LogStash::PluginMixins::JdbcStreaming::ParameterHandler.build_bind_value_handler "[field][nested]"
+      handler.extract_from(event)
+      expect(handler.extract_from(event)).to eq "nested_field"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.1.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-08-04 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:
@@ -238,6 +252,7 @@ files:
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
+- NOTICE.TXT
 - README.md
 - docs/filter-jdbc_static.asciidoc
 - docs/filter-jdbc_streaming.asciidoc
@@ -292,6 +307,7 @@ files:
 - spec/helpers/derbyrun.jar
 - spec/inputs/integration/integ_spec.rb
 - spec/inputs/jdbc_spec.rb
+- spec/plugin_mixins/jdbc_streaming/parameter_handler_spec.rb
 - vendor/jar-dependencies/org/apache/derby/derby/10.14.1.0/derby-10.14.1.0.jar
 - vendor/jar-dependencies/org/apache/derby/derbyclient/10.14.1.0/derbyclient-10.14.1.0.jar
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
@@ -317,8 +333,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
@@ -344,3 +359,4 @@ test_files:
 - spec/helpers/derbyrun.jar
 - spec/inputs/integration/integ_spec.rb
 - spec/inputs/jdbc_spec.rb
+- spec/plugin_mixins/jdbc_streaming/parameter_handler_spec.rb