logstash-input-jdbc 1.0.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a81f6af95e10aaabaaf13f6fed4257dbc75bf079
-  data.tar.gz: a8a8b89e6ed229d9b5af9cd4c2e0d3f50e611248
+  metadata.gz: e56d7c26f413e58b553ccde453d22ec8245fdccd
+  data.tar.gz: 5d9253e023e204293b44758ee3f795fef2aa7726
 SHA512:
-  metadata.gz: 05c6eb82359780216bad4946ba65fd79e9a562f244df6c109c956b289de2eb2e6da3fe7272b41ec23ea03962b7b85745e4930280b457ba71eb083779e29aebb9
-  data.tar.gz: 6ed6d9deab0a62eeb21d2610dbd81712a030164827518d7ce5a5ebddbaa170f8fa10664af405791ceefdf4ca05b9715de1c2395e0bb4507e1717169c606b63ae
+  metadata.gz: 129860f0076c9732fbd63d0ad9b3ec549d9ba7ed4018c8b1a59255350c7f2bd8825f2bc39fb3bc4932081ddec25449f35b5115a7c8210a3ec16fcb32fd2d400f
+  data.tar.gz: a9bade4dd5b1346b7b2282e83aa45cf756899d8e0ab51b1c036c346362a069e351878e959b723112a6ff791c92c845e4641069f699179eff84f27c1d8f4ca1d2

data/CHANGELOG.md

@@ -1,10 +1,7 @@
-## 1.0.2
- - Prevent multiple queries from being run simultaneously (#70)
- - Fixed regression introduced with new config options
-
-## 1.0.1
- - Added ability to configure timeout
- - Added catch-all configuration option for any other options that Sequel lib supports
-
-## 1.0.0
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+
+* 1.0.0
   - Initial release

data/lib/logstash/inputs/jdbc.rb

@@ -159,17 +159,18 @@ class LogStash::Inputs::Jdbc < LogStash::Inputs::Base
 
   def run(queue)
     if @schedule
-      @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
+      @scheduler = Rufus::Scheduler.new
       @scheduler.cron @schedule do
         execute_query(queue)
       end
+
       @scheduler.join
     else
       execute_query(queue)
     end
   end # def run
 
-  def teardown
+  def stop
     @scheduler.stop if @scheduler
 
     # update state file for next run
@@ -178,7 +179,7 @@ class LogStash::Inputs::Jdbc < LogStash::Inputs::Base
     end
 
     close_jdbc_connection
-  end # def teardown
+  end
 
   private
 

data/lib/logstash/plugin_mixins/jdbc.rb

@@ -57,37 +57,6 @@ 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.nil? ? nil : @jdbc_password.value,
-      :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
@@ -107,7 +76,7 @@ module LogStash::PluginMixins::Jdbc
                 end
       raise LogStash::ConfigurationError, "#{e}. #{message}"
     end
-    @database = jdbc_connect()
+    @database = Sequel.connect(@jdbc_connection_string, :user=> @jdbc_user, :password=>  @jdbc_password.nil? ? nil : @jdbc_password.value)
     @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.2'
+  s.version         = '2.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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
    # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency 'logstash-core', '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency 'sequel'
   s.add_runtime_dependency 'rufus-scheduler'

data/spec/inputs/jdbc_spec.rb

@@ -6,8 +6,7 @@ require "sequel/adapters/jdbc"
 require "timecop"
 require "stud/temporary"
 
-
-describe "jdbc" do
+describe LogStash::Inputs::Jdbc do
   let(:mixin_settings) { {"jdbc_user" => ENV['USER'], "jdbc_driver_class" => "org.apache.derby.jdbc.EmbeddedDriver", "jdbc_connection_string" => "jdbc:derby:memory:testdb;create=true"} }
   let(:settings) { {} }
   let(:plugin) { LogStash::Inputs::Jdbc.new(mixin_settings.merge(settings)) }
@@ -33,13 +32,22 @@ describe "jdbc" do
 
     it "should register without raising exception" do
       expect { plugin.register }.to_not raise_error
-      plugin.teardown
+      plugin.stop
     end
 
-    it "should register with password set" do
-      mixin_settings['jdbc_password'] = 'pass'
-      expect { plugin.register }.to_not raise_error
-      plugin.stop
+    it "should stop without raising exception" do
+      plugin.register
+      expect { plugin.stop }.to_not raise_error
+    end
+
+    it_behaves_like "an interruptible input plugin" do
+      let(:settings) do
+        {
+          "statement" => "SELECT 1 FROM test_table",
+          "schedule" => "* * * * * UTC"
+        }
+      end
+      let(:config) { mixin_settings.merge(settings) }
     end
   end
 
@@ -70,7 +78,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should read in statement from file" do
@@ -91,7 +99,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should retrieve params correctly from Event" do
@@ -114,7 +122,7 @@ describe "jdbc" do
         plugin.run(queue)
       end
       sleep 3
-      plugin.teardown
+      plugin.stop
       runner.kill
       runner.join
       expect(queue.size).to eq(2)
@@ -140,7 +148,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should fetch all rows" do
@@ -167,7 +175,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should successfully iterate table with respect to field values" do
@@ -206,7 +214,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should respect last run metadata" do
@@ -232,7 +240,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should ignore last run metadata if :clean_run set to true" do
@@ -254,7 +262,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should not save state if :record_last_run is false" do
@@ -282,7 +290,7 @@ describe "jdbc" do
     end
 
     after do
-      plugin.teardown
+      plugin.stop
     end
 
     it "should fetch all rows" do
@@ -302,37 +310,4 @@ 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,146 +1,144 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jdbc
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
+  name: logstash-core
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.snapshot
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-codec-plain
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: sequel
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: sequel
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rufus-scheduler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: rufus-scheduler
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: timecop
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: timecop
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: jdbc-derby
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: jdbc-derby
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: docker-api
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: docker-api
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/jdbc.rb
 - lib/logstash/plugin_mixins/jdbc.rb
 - logstash-input-jdbc.gemspec
@@ -167,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: This example input streams a string at a definable interval.

data/.gitignore

@@ -1,5 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor
-derby.log

data/Rakefile

@@ -1 +0,0 @@
-require "logstash/devutils/rake"