logstash-input-jdbc 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9026f853d22bd2451bfe72e0b045318ec605d77b
-  data.tar.gz: df99f72e2ba6ddffc1f9d40c193189a1941c2dad
+  metadata.gz: 27d1a53b69fe6d66633b4cb36874d5ca362dea40
+  data.tar.gz: 9e0eddd924c285c712b9bcd4875803275b106ed0
 SHA512:
-  metadata.gz: 948d8d265d5b6158daef86e4032958b344f49d0116ca30f6f7d3c697e875b19f69eb12ef63627c6a94c4e8bbcb5c389c9e6f935853ce5552fd2967216fe1cf92
-  data.tar.gz: e77a3ee5bac991ef164db17776c5e35713c97e4d4667a3f5703d4b09d2a15f7b67d8e6a5732e42ce450cbaa71a1223a9f5f52282d78e7915eb8c234abfef12d5
+  metadata.gz: 1be7db7d416179267954031a631b066b8856d1e396772a3f4918cdcd2f6d3e5fcb6b96967a39f16082c749859e06690acaea5cc3b062c11e0e51f8dc6d41908d
+  data.tar.gz: 5abb561d1cfe32ffa49dbed2f0358718ace6246841c4051d002580421bfbfcddc7a161500040b6c423c934e4c2ed6898109a7792cc7f26324555870bf42026eb

data/CHANGELOG.md

@@ -1,2 +1,6 @@
-* 1.0.0
+## 1.0.1
+ - Added ability to configure timeout
+ - Added catch-all configuration option for any other options that Sequel lib supports
+
+## 1.0.0
   - Initial release

data/README.md

@@ -1,15 +1,15 @@
 # Logstash JDBC Input Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -123,4 +123,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to me that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/jdbc.rb

@@ -19,19 +19,19 @@ require "yaml" # persistence
 # ==== Scheduling
 #
 # Input from this plugin can be scheduled to run periodically according to a specific 
-# schedule. This scheduling syntax is powered by [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
+# 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 ).
 #
 # Examples:
 #
 # |==========================================================
-# | * 5 * 1-3 *               | will execute every minute of 5am every day of January through March.
-# | 0 * * * *                 | will execute on the 0th minute of every hour every day.
-# | 0 6 * * * America/Chicago | will execute at 6:00am (UTC/GMT -5) every day.
+# | `* 5 * 1-3 *`               | will execute every minute of 5am every day of January through March.
+# | `0 * * * *`                 | will execute on the 0th minute of every hour every day.
+# | `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
 # |==========================================================
 #   
 #
-# Further documentation describing this syntax can be found [here](https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings)
+# Further documentation describing this syntax can be found https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
 #
 # ==== State
 #
@@ -90,9 +90,8 @@ require "yaml" # persistence
 # Here is the list:
 #
 # |==========================================================
-# |sql_last_start | The last time a statement was executed. This is set to
-# |               | Thursday, 1 January 1970 before any query is run, and updated 
-# |               | accordingly after first query is run.
+# |sql_last_start | The last time a statement was executed. This is set to Thursday, 1 January 1970
+#  before any query is run, and updated accordingly after first query is run.
 # |==========================================================
 #
 class LogStash::Inputs::Jdbc < LogStash::Inputs::Base

data/lib/logstash/plugin_mixins/jdbc.rb

@@ -57,6 +57,37 @@ module LogStash::PluginMixins::Jdbc
     # Connection pool configuration.
     # How often to validate a connection (in seconds)
     config :jdbc_validation_timeout, :validate => :number, :default => 3600
+
+    # Connection pool configuration.
+    # The amount of seconds to wait to acquire a connection before raising a PoolTimeoutError (default 5)
+    config :jdbc_pool_timeout, :validate => :number, :default => 5
+
+    # General/Vendor-specific Sequel configuration options.
+    #
+    # An example of an optional connection pool configuration
+    #    max_connections - The maximum number of connections the connection pool
+    #
+    # examples of vendor-specific options can be found in this
+    # documentation page: https://github.com/jeremyevans/sequel/blob/master/doc/opening_databases.rdoc
+    config :sequel_opts, :validate => :hash, :default => {}
+  end
+
+  private
+  def jdbc_connect
+    opts = {
+      :user => @jdbc_user,
+      :password => @jdbc_password,
+      :pool_timeout => @jdbc_pool_timeout
+    }.merge(@sequel_opts)
+    begin
+      Sequel.connect(@jdbc_connection_string, opts=opts)
+    rescue Sequel::PoolTimeout => e
+      @logger.error("Failed to connect to database. #{@jdbc_pool_timeout} second timeout exceeded.")
+      raise e
+    rescue Sequel::Error => e
+      @logger.error("Unable to connect to database", :error_message => e.message)
+      raise e
+    end
   end
 
   public
@@ -76,7 +107,7 @@ module LogStash::PluginMixins::Jdbc
                 end
       raise LogStash::ConfigurationError, "#{e}. #{message}"
     end
-    @database = Sequel.connect(@jdbc_connection_string, :user=> @jdbc_user, :password=>  @jdbc_password.nil? ? nil : @jdbc_password.value)
+    @database = jdbc_connect()
     @database.extension(:pagination)
     if @jdbc_validate_connection
       @database.extension(:connection_validator)

data/logstash-input-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-input-jdbc'
-  s.version         = '1.0.0'
+  s.version         = '1.0.1'
   s.licenses = ['Apache License (2.0)']
   s.summary = "This example input streams a string at a definable interval."
   s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/jdbc_spec.rb

@@ -301,4 +301,37 @@ describe "jdbc" do
       expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
     end
   end
+
+  context "when timing out on connection" do
+    let(:settings) do
+      {
+        "statement" => "SELECT * FROM test_table",
+        "jdbc_pool_timeout" => 0,
+        "jdbc_connection_string" => 'mock://localhost:1527/db',
+        "sequel_opts" => {
+          "max_connections" => 1
+        }
+      }
+    end
+
+    it "should raise PoolTimeout error" do
+      plugin.register
+      db = plugin.instance_variable_get(:@database)
+      expect(db.pool.instance_variable_get(:@timeout)).to eq(0)
+      expect(db.pool.instance_variable_get(:@max_size)).to eq(1)
+
+      q, q1 = Queue.new, Queue.new
+      t = Thread.new{db.pool.hold{|c| q1.push nil; q.pop}}
+      q1.pop
+      expect{db.pool.hold {|c|}}.to raise_error(Sequel::PoolTimeout)
+      q.push nil
+      t.join
+    end
+
+    it "should log error message" do
+      allow(Sequel).to receive(:connect).and_raise(Sequel::PoolTimeout)
+      expect(plugin.logger).to receive(:error).with("Failed to connect to database. 0 second timeout exceeded.")
+      expect { plugin.register }.to raise_error(Sequel::PoolTimeout)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jdbc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
 summary: This example input streams a string at a definable interval.