logstash-integration-jdbc 5.4.9 → 5.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd25bda7dbc3dbbc14d2db3d79f2aff6c4c1eb39de48c786701c998ed66fefcf
-  data.tar.gz: 519d0d5d51ad001974ccdf2ca131d81f8d2558984b78f897cb9d2f69b509e444
+  metadata.gz: 7604bb8967c9d63f585d14622ab18b70bc0d9e9b34e43bca6b6c59c9d05a6b76
+  data.tar.gz: 2e9d142376d12bbd1313142e79174d540d53e098e481330262e784c8177e4898
 SHA512:
-  metadata.gz: 4776aa8f80c18579b366713c5eea82f956e0b18304414a6bf66c3866bab4d92f08cf4c10d82ce464d2c33fef5ce51ae69102a0db814383bef4b8aa9f6e4621a7
-  data.tar.gz: 28b7b9ee174032657084ec43d55eeb9152d51689e97ccbf4d1bac826fa6890b1b9f0e3d190bc2230c5f2b1462f22249c5f18aef1ce50423838d8037c44d2f711
+  metadata.gz: 165749e33fed7d98b9635f6a1d74cdb05623563a3942d34c093ef761cd8e4f4784e6eb467a699909e5420ceef8fb4779c00e1b154845838052aa278a592ddc2a
+  data.tar.gz: b9a4e7822ea60c3dde25edd6a1a6e72837069a993046a050a05aa32e92172d4689624df12e85c31b79f62c40fd0f45f98700e07a678a7ea2656d9730f2f14a8e

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+## 5.4.11
+  - Fixes an issue in which any one instance of a JDBC input plugin using `jdbc_default_timezone` changes the behaviour of plugin instances that do _not_ use `jdbc_default_timezone`, ensuring that timezone offsets remain consistent for each instance of the plugin _as configured_ [#151](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/151)
+  - Fixes an exception that could occur while reloading `jdbc_static` databases when the underlying connection to the remote has been broken [#165](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/165)
+
+## 5.4.10
+  - Adds retry mechanism when checkout Derby from SVN repository [#158](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/158)
+  - [DOC] add known limitations and settings for connection issue [#167](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/167)
+
 ## 5.4.9
   - Fix Derby missed driver classes when built locally for version 10.15 [#160](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/160)
-  - 
+
 ## 5.4.8
   - Update Derby with locally built 10.15.2.1 version [#155](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/155) 
 

data/docs/input-jdbc.asciidoc

@@ -176,6 +176,29 @@ input {
 }
 ---------------------------------------------------------------------------------------------------
 
+==== Database-specific considerations
+
+The JDBC input plugin leverages the https://github.com/jeremyevans/sequel[sequel] library to query databases through their JDBC drivers.
+The implementation of drivers will vary, however, potentially leading to unexpected behavior.
+
+===== Unable to reuse connections
+
+Some databases - such as Sybase or SQL Anywhere - may have issues with stale connections, timing out between scheduled runs and never reconnecting.
+
+To ensure connections are valid before queries are executed, enable <<plugins-{type}s-{plugin}-jdbc_validate_connection>> and set <<plugins-{type}s-{plugin}-jdbc_validation_timeout>> to a shorter interval than the <<plugins-{type}s-{plugin}-schedule>>.
+
+[source,ruby]
+---------------------------------------------------------------------------------------------------
+input {
+  jdbc {
+    schedule => "* * * * *"       # run every minute
+    jdbc_validate_connection => true
+    jdbc_validation_timeout => 50 # 50 seconds
+  }
+}
+---------------------------------------------------------------------------------------------------
+
+
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== Jdbc Input Configuration Options

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

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require "fileutils"
-require "sequel"
+require "logstash/plugin_mixins/jdbc/sequel_bootstrap"
 require "sequel/adapters/jdbc"
 require "java"
 require "logstash/util/loggable"

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

@@ -12,7 +12,7 @@ module LogStash module Filters module Jdbc
         if connected?
           result = @db[statement].count
         else
-          debug_log_messages.concat("and there is no connection to the remote db at this time")
+          debug_log_messages << "and there is no connection to the remote db at this time"
         end
       rescue ::Sequel::Error => err
         # a fatal issue
@@ -32,7 +32,7 @@ module LogStash module Filters module Jdbc
         if connected?
           result = @db[statement].all
         else
-          debug_log_messages.concat("and there is no connection to the remote db at this time")
+          debug_log_messages << "and there is no connection to the remote db at this time"
         end
       rescue ::Sequel::Error => err
         # a fatal issue

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

@@ -24,7 +24,8 @@ module LogStash module PluginMixins module Jdbc
       return @driver_impl if @driver_impl ||= nil
 
       require "java"
-      require "sequel"
+
+      require_relative "sequel_bootstrap"
       require "sequel/adapters/jdbc"
 
       # execute all the driver loading related duties in a serial fashion to avoid

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require "sequel"
+
+# prevent Sequel's datetime_class from being modified,
+# and ensure behaviour is restored to the library's default
+# if something else in the Ruby VM has already changed it.
+Sequel.synchronize do
+  def Sequel.datetime_class=(klass)
+    # noop
+  end
+  def Sequel.datetime_class
+    ::Time
+  end
+end
+
+# load the named_timezones extension, which will attempt to
+# override the global Sequel::datetime_class; for safety,
+# we reset it once more.
+Sequel.extension(:named_timezones)
+Sequel.datetime_class = ::Time

data/logstash-integration-jdbc.gemspec

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

@@ -601,6 +601,33 @@ describe LogStash::Inputs::Jdbc do
       # With no timezone set, no change should occur
       expect(event.get("custom_time").time).to eq(Time.iso8601("2015-01-01T12:00:00Z"))
     end
+
+    %w(
+        Etc/UTC
+        America/Los_Angeles
+        Europe/Berlin
+        Asia/Tokyo
+      ).each do |local_timezone|
+      context "when host machine has timezone `#{local_timezone}`" do
+        around(:each) do |example|
+          begin
+            previous_tz = ENV['TZ']
+            ENV['TZ'] = local_timezone
+            example.call
+          ensure
+            ENV['TZ'] = previous_tz
+          end
+        end
+
+        let(:tz) { TZInfo::Timezone.get(local_timezone) }
+
+        it "converts the time using the machine's local timezone" do
+          plugin.run(queue)
+          event = queue.pop
+          expect(event.get("custom_time").time).to eq(Time.new(2015,1,1,12,0,0,tz))
+        end
+      end
+    end
   end
 
   context "when iteratively running plugin#run" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.4.9
+  version: 5.4.11
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -17,8 +17,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
   name: jar-dependencies
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -34,8 +34,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
   name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,8 +51,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.5.0
   name: logstash-core
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -65,8 +65,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-plain
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -79,8 +79,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.74.0
   name: sequel
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,8 +93,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: lru_redux
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,8 +107,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: tzinfo
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,8 +121,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: tzinfo-data
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -135,8 +135,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
   name: logstash-mixin-ecs_compatibility_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -149,8 +149,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-mixin-validator_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -163,8 +163,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-mixin-event_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -177,8 +177,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-mixin-scheduler
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -191,8 +191,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: childprocess
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -205,8 +205,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -219,8 +219,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: timecop
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -263,6 +263,7 @@ files:
 - lib/logstash/inputs/tzinfo_jruby_patch.rb
 - lib/logstash/plugin_mixins/jdbc/common.rb
 - lib/logstash/plugin_mixins/jdbc/jdbc.rb
+- lib/logstash/plugin_mixins/jdbc/sequel_bootstrap.rb
 - lib/logstash/plugin_mixins/jdbc/statement_handler.rb
 - lib/logstash/plugin_mixins/jdbc/timezone_proxy.rb
 - lib/logstash/plugin_mixins/jdbc/value_tracking.rb
@@ -322,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Integration with JDBC - input and filter plugins