logstash-integration-jdbc 5.2.4 → 5.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad77fc92ab07e1da7e4c6285075b6583f9f293c073199b614e3852cd22bbc6a9
-  data.tar.gz: 9e7b2c0f0c16930903bdee1f22b2651db7cf9f80d01a12f212b7a40155d4ebea
+  metadata.gz: b74796568bc1df12ae5015cfcf38aeb43971b3bd3eda2dcc668104decc69b6a2
+  data.tar.gz: ae3a1f82f7354798692933a2426977ea2e17f7335a74d02eb09a376e4421af6b
 SHA512:
-  metadata.gz: 2928a01bbe1ef418f36d6ddc7847416fc6d43278b20242926037bef02e8a429ba1d4587f1bd88f8d52de2ec1fef26e749aeb358de82a8bf69c36e5c3c9d42f8e
-  data.tar.gz: 8aae596826ec1d9155e0f8bdfad9a882e92fa2be610f89d7c67a7b3f44f0e6937bcbafd78900457d92b20a5a28188163f7b4f25040d8deb229f505ab6faf2c22
+  metadata.gz: d198c08e74dc4702dae5de1ca4661d68d10298ff497e44739e7cc775d575bfc9fe825154a9de6f2497e60fb3c694f06d36d8971ecf9935e13592c959d6c13c53
+  data.tar.gz: ccd725393201ec5282644f003880fa0449a027942442698fe6e1758f25335ff585efb73d0f52716c9698eb19990ef67a15b21fef90255473b39683339520796a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.2.5
+  - Fix: do not execute more queries with debug logging [#109](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/109)
+
 ## 5.2.4
   - Fix: compatibility with all (>= 3.0) rufus-scheduler versions [#97](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/97) 
 

data/lib/logstash/inputs/jdbc.rb

@@ -259,8 +259,8 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
       end
     end
 
-    set_value_tracker(LogStash::PluginMixins::Jdbc::ValueTracking.build_last_value_tracker(self))
-    set_statement_logger(LogStash::PluginMixins::Jdbc::CheckedCountLogger.new(@logger))
+    set_value_tracker LogStash::PluginMixins::Jdbc::ValueTracking.build_last_value_tracker(self)
+    set_statement_handler LogStash::PluginMixins::Jdbc::StatementHandler.build_statement_handler(self)
 
     @enable_encoding = !@charset.nil? || !@columns_charset.empty?
 
@@ -283,8 +283,8 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
   end # def register
 
   # test injection points
-  def set_statement_logger(instance)
-    @statement_handler = LogStash::PluginMixins::Jdbc::StatementHandler.build_statement_handler(self, instance)
+  def set_statement_handler(handler)
+    @statement_handler = handler
   end
 
   def set_value_tracker(instance)

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

@@ -4,7 +4,6 @@ require "logstash/config/mixin"
 require "time"
 require "date"
 require_relative "value_tracking"
-require_relative "checked_count_logger"
 require_relative "statement_handler"
 
 java_import java.util.concurrent.locks.ReentrantLock

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

@@ -2,7 +2,7 @@
 
 module LogStash module PluginMixins module Jdbc
   class StatementHandler
-    def self.build_statement_handler(plugin, logger)
+    def self.build_statement_handler(plugin)
       if plugin.use_prepared_statements
         klass = PreparedStatementHandler
       else
@@ -16,27 +16,39 @@ module LogStash module PluginMixins module Jdbc
           klass = NormalStatementHandler
         end
       end
-      klass.new(plugin, logger)
+      klass.new(plugin)
     end
 
-    attr_reader :statement, :parameters, :statement_logger
+    attr_reader :statement, :parameters
 
-    def initialize(plugin, statement_logger)
+    def initialize(plugin)
       @statement = plugin.statement
-      @statement_logger = statement_logger
-      post_init(plugin)
     end
 
     def build_query(db, sql_last_value)
-      # override in subclass
+      fail NotImplementedError # override in subclass
     end
 
-    def post_init(plugin)
-      # override in subclass, if needed
-    end
   end
 
   class NormalStatementHandler < StatementHandler
+
+    attr_reader :parameters
+
+    def initialize(plugin)
+      super(plugin)
+      @parameter_keys = ["sql_last_value"] + plugin.parameters.keys
+      @parameters = plugin.parameters.inject({}) do |hash,(k,v)|
+        case v
+        when LogStash::Timestamp
+          hash[k.to_sym] = v.time
+        else
+          hash[k.to_sym] = v
+        end
+        hash
+      end
+    end
+
     # Performs the query, yielding once per row of data
     # @param db [Sequel::Database]
     # @param sql_last_value [Integer|DateTime|Time]
@@ -52,27 +64,18 @@ module LogStash module PluginMixins module Jdbc
 
     def build_query(db, sql_last_value)
       parameters[:sql_last_value] = sql_last_value
-      query = db[statement, parameters]
-      statement_logger.log_statement_parameters(statement, parameters, query)
-      query
+      db[statement, parameters]
     end
 
-    def post_init(plugin)
-      @parameter_keys = ["sql_last_value"] + plugin.parameters.keys
-      @parameters = plugin.parameters.inject({}) do |hash,(k,v)|
-        case v
-        when LogStash::Timestamp
-          hash[k.to_sym] = v.time
-        else
-          hash[k.to_sym] = v
-        end
-        hash
-      end
-    end
   end
 
   class PagedNormalStatementHandler < NormalStatementHandler
-    attr_reader :jdbc_page_size
+
+    def initialize(plugin)
+      super(plugin)
+      @jdbc_page_size = plugin.jdbc_page_size
+      @logger = plugin.logger
+    end
 
     # Performs the query, respecting our pagination settings, yielding once per row of data
     # @param db [Sequel::Database]
@@ -81,16 +84,22 @@ module LogStash module PluginMixins module Jdbc
     def perform_query(db, sql_last_value)
       query = build_query(db, sql_last_value)
       query.each_page(@jdbc_page_size) do |paged_dataset|
+        log_dataset_page(paged_dataset) if @logger.debug?
         paged_dataset.each do |row|
           yield row
         end
       end
     end
 
-    def post_init(plugin)
-      super(plugin)
-      @jdbc_page_size = plugin.jdbc_page_size
+    private
+
+    # @param paged_dataset [Sequel::Dataset::Pagination] like object
+    def log_dataset_page(paged_dataset)
+      @logger.debug "fetching paged dataset", current_page: paged_dataset.current_page,
+                                              record_count: paged_dataset.current_page_record_count,
+                                              total_record_count: paged_dataset.pagination_record_count
     end
+
   end
 
   class ExplicitPagingModeStatementHandler < PagedNormalStatementHandler
@@ -101,20 +110,29 @@ module LogStash module PluginMixins module Jdbc
     def perform_query(db, sql_last_value)
       query = build_query(db, sql_last_value)
       offset = 0
+      page_size = @jdbc_page_size
       loop do
         rows_in_page = 0
-        query.with_sql(query.sql, offset: offset, size: jdbc_page_size).each do |row|
+        query.with_sql(query.sql, offset: offset, size: page_size).each do |row|
           yield row
           rows_in_page += 1
         end
-        break unless rows_in_page == jdbc_page_size
-        offset += jdbc_page_size
+        break unless rows_in_page == page_size
+        offset += page_size
       end
     end
   end
 
   class PreparedStatementHandler < StatementHandler
-    attr_reader :name, :bind_values_array, :statement_prepared, :prepared
+    attr_reader :name, :bind_values_array, :statement_prepared, :prepared, :parameters
+
+    def initialize(plugin)
+      super(plugin)
+      @name = plugin.prepared_statement_name.to_sym
+      @bind_values_array = plugin.prepared_statement_bind_values
+      @parameters = plugin.parameters
+      @statement_prepared = Concurrent::AtomicBoolean.new(false)
+    end
 
     # Performs the query, ignoring our pagination settings, yielding once per row of data
     # @param db [Sequel::Database]
@@ -142,7 +160,6 @@ module LogStash module PluginMixins module Jdbc
         db.set_prepared_statement(name, prepared)
       end
       bind_value_sql_last_value(sql_last_value)
-      statement_logger.log_statement_parameters(statement, parameters, nil)
       begin
         db.call(name, parameters)
       rescue => e
@@ -153,17 +170,6 @@ module LogStash module PluginMixins module Jdbc
       end
     end
 
-    def post_init(plugin)
-      # don't log statement count when using prepared statements for now...
-      # needs enhancement to allow user to supply a bindable count prepared statement in settings.
-      @statement_logger.disable_count
-
-      @name = plugin.prepared_statement_name.to_sym
-      @bind_values_array = plugin.prepared_statement_bind_values
-      @parameters = plugin.parameters
-      @statement_prepared = Concurrent::AtomicBoolean.new(false)
-    end
-
     def create_bind_values_hash
       hash = {}
       bind_values_array.each_with_index {|v,i| hash[:"p#{i}"] = v}

data/logstash-integration-jdbc.gemspec

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

data/spec/inputs/integration/integ_spec.rb

@@ -41,6 +41,31 @@ describe LogStash::Inputs::Jdbc, :integration => true do
       expect(event.get('first_name')).to eq("Mark")
       expect(event.get('last_name')).to eq("Guckenheimer")
     end
+
+    context 'with paging' do
+      let(:settings) do
+        super().merge 'jdbc_paging_enabled' => true, 'jdbc_page_size' => 1,
+                      "statement" => 'SELECT * FROM "employee" WHERE EMP_NO >= :p1 ORDER BY EMP_NO',
+                      'parameters' => { 'p1' => 0 }
+      end
+
+      before do # change plugin logger level to debug - to exercise logging
+        logger = plugin.class.name.gsub('::', '.').downcase
+        logger = org.apache.logging.log4j.LogManager.getLogger(logger)
+        @prev_logger_level = [ logger.getName, logger.getLevel ]
+        org.apache.logging.log4j.core.config.Configurator.setLevel logger.getName, org.apache.logging.log4j.Level::DEBUG
+      end
+
+      after do
+        org.apache.logging.log4j.core.config.Configurator.setLevel *@prev_logger_level
+      end
+
+      it "should populate the event with database entries" do
+        plugin.run(queue)
+        event = queue.pop
+        expect(event.get('first_name')).to eq('David')
+      end
+    end
   end
 
   context "when supplying a non-existent library" do

data/spec/inputs/jdbc_spec.rb

@@ -1432,54 +1432,6 @@ describe LogStash::Inputs::Jdbc do
     end
   end
 
-  context "when debug logging and a count query raises a count related error" do
-    let(:settings) do
-      { "statement" => "SELECT * from types_table" }
-    end
-    let(:logger) { double("logger", :debug? => true) }
-    let(:statement_logger) { LogStash::PluginMixins::Jdbc::CheckedCountLogger.new(logger) }
-    let(:value_tracker) { double("value tracker", :set_value => nil, :write => nil) }
-    let(:msg) { 'Java::JavaSql::SQLSyntaxErrorException: Dynamic SQL Error; SQL error code = -104; Token unknown - line 1, column 105; LIMIT [SQLState:42000, ISC error code:335544634]' }
-    let(:error_args) do
-      {"exception" => msg}
-    end
-
-    before do
-      db << "INSERT INTO types_table (num, string, started_at, custom_time, ranking) VALUES (1, 'A test', '1999-12-31', '1999-12-31 23:59:59', 95.67)"
-      plugin.register
-      plugin.set_statement_logger(statement_logger)
-      plugin.set_value_tracker(value_tracker)
-      allow(value_tracker).to receive(:value).and_return("bar")
-      allow(statement_logger).to receive(:execute_count).once.and_raise(StandardError.new(msg))
-    end
-
-    after do
-      plugin.stop
-    end
-
-    context "if the count query raises an error" do
-      it "should log a debug line without a count key as its unknown whether a count works at this stage" do
-        expect(logger).to receive(:warn).once.with("Attempting a count query raised an error, the generated count statement is most likely incorrect but check networking, authentication or your statement syntax", error_args)
-        expect(logger).to receive(:warn).once.with("Ongoing count statement generation is being prevented")
-        expect(logger).to receive(:debug).once.with("Executing JDBC query", :statement => settings["statement"], :parameters => {:sql_last_value=>"bar"})
-        plugin.run(queue)
-        queue.pop
-      end
-
-      it "should create an event normally" do
-        allow(logger).to receive(:warn)
-        allow(logger).to receive(:debug)
-        plugin.run(queue)
-        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_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
-  end
-
   context "when an unreadable jdbc_driver_path entry is present" do
     let(:driver_jar_path) do
       jar_file = $CLASSPATH.find { |name| name.index(Jdbc::Derby.driver_jar) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.2.4
+  version: 5.2.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +275,6 @@ files:
 - lib/logstash/filters/jdbc_streaming.rb
 - lib/logstash/inputs/jdbc.rb
 - lib/logstash/inputs/tzinfo_jruby_patch.rb
-- lib/logstash/plugin_mixins/jdbc/checked_count_logger.rb
 - lib/logstash/plugin_mixins/jdbc/common.rb
 - lib/logstash/plugin_mixins/jdbc/jdbc.rb
 - lib/logstash/plugin_mixins/jdbc/scheduler.rb

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

@@ -1,43 +0,0 @@
-# encoding: utf-8
-
-module LogStash module PluginMixins module Jdbc
-  class CheckedCountLogger
-    def initialize(logger)
-      @logger = logger
-      @needs_check = true
-      @count_is_supported = false
-      @in_debug = @logger.debug?
-    end
-
-    def disable_count
-      @needs_check = false
-      @count_is_supported = false
-    end
-
-    def log_statement_parameters(statement, parameters, query)
-      return unless @in_debug
-      check_count_query(query) if @needs_check && query
-      if @count_is_supported
-        @logger.debug("Executing JDBC query", :statement => statement, :parameters => parameters, :count => execute_count(query))
-      else
-        @logger.debug("Executing JDBC query", :statement => statement, :parameters => parameters)
-      end
-    end
-
-    def check_count_query(query)
-      @needs_check = false
-      begin
-        execute_count(query)
-        @count_is_supported = true
-      rescue Exception => e
-        @logger.warn("Attempting a count query raised an error, the generated count statement is most likely incorrect but check networking, authentication or your statement syntax", "exception" => e.message)
-        @logger.warn("Ongoing count statement generation is being prevented")
-        @count_is_supported = false
-      end
-    end
-
-    def execute_count(query)
-      query.count
-    end
-  end
-end end end