logstash-integration-jdbc 5.5.3 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a28e2a3a37342bc631ed300da7fa687e99fc879d8cc599669d64e2cfc6418177
-  data.tar.gz: 38b675462f29af81148dbdcc58144a2e3df932b6c6a44825b580a3468ac90acb
+  metadata.gz: a562598bdb5d577eb9dc0cd8d419dcdf26d22e04e07446dfc44cf22e877ff0f4
+  data.tar.gz: ab6adff6a86ec1bebdc887e1ec874520bf24256330d6b7a0c74be764d278541c
 SHA512:
-  metadata.gz: b3af9d1d0c7ddc88b8102d7fafb96a9c379a734266698a3136e9e9522f640f64f4f019ea5820c9bc382a460df5f47f2fc62bb6cf8c3ad47ad84f5069710831cd
-  data.tar.gz: 41a6e399b350068d1ed337c158b94f9457f0ace2f31588888db8c99b9e20a39f7fe0f06ab4e809cd01c7a635c9ede2a00629aa1ecf04b9cd86951fdda5c9a828
+  metadata.gz: 0e262fa20df3ee0cc8e1cf9f9ec8f68c0529f571166718e9d9dfeb050712cd3760b903c1d116cdebe1067352708e7bff5b04acdb55dca3112a5cb136831ebedc
+  data.tar.gz: 8c13ff927125d49032b6339d08caa95c0b18b1669de3bf8dfbd0432c8a7543c0d9ea92260b2fa6d79e5166aa3756a60a981b49ad59b6ee4710d7794ebf5fc759

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.6.0
+  - Support other rufus scheduling options in JDBC Input [#183](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/183)
+
 ## 5.5.3
   - [DOC] Rework inline comment to a callout in preparation for upcoming MD conversion [#181](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/181)
 

data/docs/input-jdbc.asciidoc

@@ -41,9 +41,9 @@ options for more info.
 
 Input from this plugin can be scheduled to run periodically according to a specific
 schedule. This scheduling syntax is powered by https://github.com/jmettraux/rufus-scheduler[rufus-scheduler].
-The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
+The syntax is either cron-like with some extensions specific to Rufus (e.g. timezone support ) if using the `schedule` option or periodic when using `period` or `interval` option.
 
-Examples:
+Examples for `schedule`:
 
 |==========================================================
 | `* 5 * 1-3 *`               | will execute every minute of 5am every day of January through March.
@@ -51,9 +51,21 @@ Examples:
 | `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
 |==========================================================
 
+Examples for `period` or `interval`:
+
+|==========================================================
+| `1m`                        | will execute every minute
+| `3h10m`                     | will execute every three hours and 10 minutes
+|==========================================================
 
 Further documentation describing this syntax can be found https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
 
+`interval` jobs trigger, execute and then trigger again after the interval elapsed.
+
+`period` jobs try to trigger following the frequency they were scheduled with.
+
+You can only use one of `interval`, `period` or `schedule` at the same time.
+
 ==== State
 
 The plugin will persist the `sql_last_value` parameter in the form of a
@@ -212,6 +224,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-columns_charset>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-connection_retry_attempts>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-connection_retry_attempts_wait_time>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-interval>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-jdbc_connection_string>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-jdbc_default_timezone>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-jdbc_driver_class>> |<<string,string>>|Yes
@@ -229,6 +242,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-last_run_metadata_path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-lowercase_column_names>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-parameters>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-period>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-plugin_timezone>> |<<string,string>>, one of `["local", "utc"]`|No
 | <<plugins-{type}s-{plugin}-prepared_statement_bind_values>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-prepared_statement_name>> |<<string,string>>|No
@@ -298,6 +312,16 @@ Maximum number of times to try connecting to database
 
 Number of seconds to sleep between connection attempts
 
+[id="plugins-{type}s-{plugin}-interval"]
+===== `interval`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+This takes a string in the form of `1h`, `1m`, to denote a time interval. `interval` jobs trigger, execute and trigger again after the provided time interval has elapsed.
+
+There is no schedule by default. If no scheduling statement is given, then the statement is run exactly once.
+
 [id="plugins-{type}s-{plugin}-jdbc_connection_string"]
 ===== `jdbc_connection_string`
 
@@ -538,6 +562,16 @@ Whether to force the lowercasing of identifier fields
 
 Hash of query parameter, for example `{ "target_id" => "321" }`
 
+[id="plugins-{type}s-{plugin}-period"]
+===== `period`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+This takes a string in the form of `1h`, `1m`, to denote a time interval. `period` jobs try hard to trigger following the frequency they were scheduled with.
+
+There is no schedule by default. If no scheduling statement is given, then the statement is run exactly once.
+
 [id="plugins-{type}s-{plugin}-prepared_statement_bind_values"]
 ===== `prepared_statement_bind_values`
 
@@ -568,11 +602,9 @@ Whether to save state or not in <<plugins-{type}s-{plugin}-last_run_metadata_pat
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-Schedule of when to periodically run statement, in Cron format
-for example: "* * * * *" (execute query every minute, on the minute)
+Schedule of when to periodically run statement, in Cron format for example: "* * * * *" (execute query every minute, on the minute)
 
-There is no schedule by default. If no schedule is given, then the statement is run
-exactly once.
+There is no schedule by default. If no scheduling statement is given, then the statement is run exactly once.
 
 [id="plugins-{type}s-{plugin}-sequel_opts"]
 ===== `sequel_opts`

data/lib/logstash/inputs/jdbc.rb

@@ -180,6 +180,20 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
   # exactly once.
   config :schedule, :validate => :string
 
+  # Interval of how soon to run statement again after completion
+  # for example: "1m" (execute again 1 minute after completion)
+  #
+  # There is no interval by default. If no interval is given, then the statement is run
+  # exactly once.
+  config :interval, :validate => :string
+
+  # Start the job periodically after time elapsed
+  # for example: "1m" (execute query every minute)
+  #
+  # There is no period by default. If no period is given, then the statement is run
+  # exactly once.
+  config :period, :validate => :string
+
   # Path to file with last run time.
   # The default will write file to `<path.data>/plugins/inputs/jdbc/logstash_jdbc_last_run`
   # NOTE: it must be a file path and not a directory path
@@ -241,6 +255,11 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
   def register
     @logger = self.logger
 
+    if [@interval, @schedule, @period].compact.size > 1
+      raise LogStash::ConfigurationError.new("Use only one of: interval, period, schedule.")
+    end
+
+
     if @record_last_run
       if @last_run_metadata_path.nil?
         logstash_data_path = LogStash::SETTINGS.get_value("path.data")
@@ -322,6 +341,12 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
       # scheduler input thread name example: "[my-oracle]|input|jdbc|scheduler"
       scheduler.cron(@schedule) { execute_query(queue) }
       scheduler.join
+    elsif @interval
+      scheduler.interval(@interval) { execute_query(queue) }
+      scheduler.join
+    elsif @period
+      scheduler.every(@period) { execute_query(queue) }
+      scheduler.join
     else
       execute_query(queue)
     end

data/logstash-integration-jdbc.gemspec

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

@@ -228,6 +228,33 @@ describe LogStash::Inputs::Jdbc do
     end
   end
 
+  describe "scheduling options" do
+    let(:settings) { super().merge("statement" => "SELECT :num_param as num_param FROM SYSIBM.SYSDUMMY1") }
+    scheduling_options = ["interval", "schedule", "period"]
+    scheduling_options.combination(2).each do |option1, option2|
+      context "when using '#{option1}' and '#{option2}' at the same time" do
+        let(:settings) { super().merge(option1 => 'a', option2 => 'b') }
+        it "raises a configuration error" do
+          expect { plugin.register }.to raise_error(LogStash::ConfigurationError, /Use only one/)
+        end
+      end
+    end
+    context "when using 'schedule', 'period' and 'interval' at the same time" do
+      let(:settings) { super().merge("interval" => "a", "period" => "b", "schedule" => "c") }
+      it "raises a configuration error" do
+        expect { plugin.register }.to raise_error(LogStash::ConfigurationError, /Use only one/)
+      end
+    end
+    scheduling_options.each do |option|
+      context "when using only '#{option}'" do
+        let(:settings) { super().merge(option => "a") }
+        it "does not raise a configuration error" do
+          expect { plugin.register }.to_not raise_error
+        end
+      end
+    end
+  end
+
   context "when scheduling" do
     let(:settings) { {"statement" => "SELECT 1 as num_param FROM SYSIBM.SYSDUMMY1", "schedule" => "* * * * * UTC"} }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.5.3
+  version: 5.6.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement