logstash-input-jdbc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fc1b073511bb9288a73ba28f953cf5cda3574e3
+  data.tar.gz: c477bdcba05546244e43827fc95a577cb3fe5872
+SHA512:
+  metadata.gz: eba2db8acf799e38e3b9efc8106ce33577923412d4128265e1a8a7fbf1dab194f3fa54012d507818e2385a81ff00dc7990d486638ae49fc2d7b5e8a50c460e94
+  data.tar.gz: 849eb469d3a605883e4f1ea6fdfac1c6de614235f7fe51b953119ee24148014af2cb21e15fd74efda3e86e2077c86b88070cb2e0a1d5d0a09c510f930663b8c3

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,97 @@
+# Logstash JDBC Input Plugin
+
+## WIP: Under Development, NOT FOR PRODUCTION
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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/).
+
+- 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
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-input-jdbc", :path => "/your/local/logstash-input-jdbc"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'input {jdbc {..}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-input-jdbc.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-input-jdbc.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+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.

data/Rakefile

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

data/lib/logstash/inputs/jdbc.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/plugin_mixins/jdbc"
+
+# INFORMATION
+#
+# This plugin was created as a way to iteratively ingest any database
+# with a JDBC interface into Logstash.
+#
+# #### JDBC Mixin
+#
+# This plugin utilizes a mixin that helps Logstash plugins manage JDBC connections.
+# The mixin provides its own set of configurations (some are required) to properly 
+# set up the connection to the appropriate database.
+#
+# #### Predefined Parameters
+#
+# Some parameters are built-in and can be used from within your queries.
+# Here is the list:
+#
+# |==========================================================
+# |sql_last_start |The time the last query executed in plugin
+# |==========================================================
+#
+# #### Usage:
+# This is an example logstash config
+# [source,ruby]
+# input {
+#   jdbc {
+#     jdbc_driver_class => "org.apache.derby.jdbc.EmbeddedDriver" (required; from mixin)
+#     jdbc_connection_string => "jdbc:derby:memory:testdb;create=true" (required; from mixin)
+#     jdbc_user => "username" (from mixin)
+#     jdbc_password => "mypass" (from mixin)
+#     statement => "SELECT * from table where created_at > :sql_last_start and id = :my_id" (required)
+#     parameters => { "my_id" => "231" }
+#     schedule => "* * * * *"
+#   }
+# }
+class LogStash::Inputs::Jdbc < LogStash::Inputs::Base
+  include LogStash::PluginMixins::Jdbc
+  config_name "jdbc"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain" 
+
+  # Statement to execute
+  # To use parameters, use named parameter syntax.
+  # For example:
+  # "SELECT * FROM MYTABLE WHERE id = :target_id"
+  # here ":target_id" is a named parameter
+  #
+  config :statement, :validate => :string, :required => true
+
+  # Hash of query parameter, for example `{ "target_id" => "321" }`
+  config :parameters, :validate => :hash, :default => {}
+
+  # Schedule of when to periodically run statement, in Cron format
+  # for example: "* * * * *" (execute query every minute, on the minute)
+  config :schedule, :validate => :string
+
+  public
+
+  def register
+    require "rufus/scheduler"
+    prepare_jdbc_connection()
+  end # def register
+
+  def run(queue)
+    if @schedule
+      @scheduler = Rufus::Scheduler.new
+      @scheduler.cron @schedule do
+        execute_query(queue)
+      end
+      @scheduler.join
+    else
+      execute_query(queue)
+    end
+  end # def run
+
+  def teardown
+    if @scheduler
+      @scheduler.stop
+    end
+    close_jdbc_connection()
+  end # def teardown
+
+  private
+  def execute_query(queue)
+    # update default parameters
+    @parameters['sql_last_start'] = @sql_last_start
+    execute_statement(@statement, @parameters) do |row|
+      event = LogStash::Event.new(row)
+      decorate(event)
+      queue << event
+    end
+  end
+end # class LogStash::Inputs::Jdbc

data/lib/logstash/plugin_mixins/jdbc.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+# TAKEN FROM WIIBAA
+require "logstash/config/mixin"
+
+# Tentative of abstracting JDBC logic to a mixin 
+# for potential reuse in other plugins (input/output)
+module LogStash::PluginMixins::Jdbc
+
+  @logger = Cabin::Channel.get(LogStash)
+
+  # This method is called when someone includes this module
+  def self.included(base)
+    # Add these methods to the 'base' given.
+    base.extend(self)
+    base.setup_jdbc_config
+
+    @sql_last_start = Time.at(0).utc
+  end
+
+
+  public
+  def setup_jdbc_config
+    # JDBC driver library path to third party driver library.
+    config :jdbc_driver_library, :validate => :path
+
+    # JDBC driver class to load, for example "oracle.jdbc.OracleDriver" or "org.apache.derby.jdbc.ClientDriver"
+    config :jdbc_driver_class, :validate => :string, :required => true
+
+    # JDBC connection string
+    config :jdbc_connection_string, :validate => :string, :required => true
+
+    # JDBC user
+    config :jdbc_user, :validate => :string, :default => "tal"
+
+    # JDBC password
+    config :jdbc_password, :validate => :password
+
+    # Connection pool configuration.
+    # Validate connection before use.
+    config :jdbc_validate_connection, :validate => :boolean, :default => false
+
+    # Connection pool configuration.
+    # How often to validate a connection (in seconds)
+    config :jdcb_validation_timeout, :validate => :number, :default => 3600
+  end
+
+  public
+  def prepare_jdbc_connection
+    require "java"
+    require "sequel"
+    require "sequel/adapters/jdbc"
+    require @jdbc_driver_library if @jdbc_driver_library
+    Sequel::JDBC.load_driver(@jdbc_driver_class)
+    @database = Sequel.connect(@jdbc_connection_string, :user=> @jdbc_user, :password=>  @jdbc_password.nil? ? nil : @jdbc_password.value)
+    if @jdbc_validate_connection
+      @database.extension(:connection_validator)
+      @database.pool.connection_validation_timeout = @jdcb_validation_timeout
+    end
+    begin
+      @database.test_connection
+    rescue Sequel::DatabaseConnectionError => e
+      #TODO return false and let the plugin raise a LogStash::ConfigurationError
+      raise e
+    end
+  end # def prepare_jdbc_connection
+
+  public
+  def close_jdbc_connection
+    @database.disconnect if @database
+  end
+
+  public
+  def execute_statement(statement, parameters)
+    success = false
+    begin 
+      parameters = symbolized_params(parameters)
+      query = @database[statement, parameters]
+      @logger.debug? and @logger.debug("Executing JDBC query", :statement => statement, :parameters => parameters)
+      @sql_last_start = Time.now.utc
+      query.all do |row|
+        #Stringify row keys
+        yield Hash[row.map { |k, v| [k.to_s, v] }]
+      end
+      success = true
+    rescue Sequel::DatabaseConnectionError, Sequel::DatabaseError => e
+      @logger.warn("Exception when executing JDBC query", :exception => e)
+    end
+    return success
+  end
+
+  # Symbolize parameters keys to use with Sequel
+  private 
+  def symbolized_params(parameters)
+    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

data/logstash-input-jdbc.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-jdbc'
+  s.version         = '0.1.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"
+  s.authors = ["Elastic"]
+  s.email = 'info@elastic.co'
+  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'sequel'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'rufus-scheduler'
+  s.add_development_dependency 'jdbc-derby'
+end

data/spec/inputs/jdbc_spec.rb

@@ -0,0 +1,84 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/jdbc"
+require "jdbc/derby"
+require "timecop"
+
+
+describe "jdbc" do
+  let(:mixin_settings) { {"jdbc_driver_class" => "org.apache.derby.jdbc.EmbeddedDriver", "jdbc_connection_string" => "jdbc:derby:memory:testdb;create=true"} }
+
+  before :each do
+    Jdbc::Derby.load_driver
+  end
+
+  it "should register and tear down" do
+    settings = {"statement" => "SELECT 1 as col1 FROM SYSIBM.SYSDUMMY1"}
+    plugin = LogStash::Plugin.lookup("input", "jdbc").new(mixin_settings.merge(settings))
+    expect { plugin.register }.to_not raise_error
+    expect { plugin.teardown }.to_not raise_error
+  end
+
+  it "should retrieve params correctly from Event" do
+    settings = {"statement" => "SELECT :num_param as num_param FROM SYSIBM.SYSDUMMY1", "parameters" => {"num_param" => 10} }
+    plugin = LogStash::Inputs::Jdbc.new(mixin_settings.merge(settings))
+    plugin.register
+    q = Queue.new
+    plugin.run(q)
+    insist { q.size } == 1
+    insist { q.pop['num_param'] } == settings['parameters']['num_param']
+    plugin.teardown
+  end
+
+  it "should properly schedule" do
+    settings = {"statement" => "SELECT 1 as num_param FROM SYSIBM.SYSDUMMY1", "schedule" => "* * * * *"}
+    plugin = LogStash::Inputs::Jdbc.new(mixin_settings.merge(settings))
+    plugin.register
+    q = Queue.new
+    Timecop.travel(Time.new(2000))
+    Timecop.scale(60)
+    runner = Thread.new do
+      plugin.run(q)
+    end
+    sleep 3
+    plugin.teardown
+    runner.kill
+    runner.join
+    insist { q.size } == 2
+    Timecop.return
+  end
+
+  it "should successfully iterate table with respect to field values" do
+    require "sequel"
+    require "sequel/adapters/jdbc"
+    Jdbc::Derby.load_driver
+    @database = Sequel.connect(mixin_settings['jdbc_connection_string'], :user=> nil, :password=> nil)
+    @database.create_table :test_table do
+      DateTime :created_at
+      Integer :num
+    end
+    test_table = @database[:test_table]
+    settings = {"statement" => "SELECT num, created_at FROM test_table WHERE created_at > :sql_last_start"}
+    plugin = LogStash::Inputs::Jdbc.new(mixin_settings.merge(settings))
+    plugin.register
+    q = Queue.new
+
+    nums = [10, 20, 30, 40, 50]
+    plugin.run(q)
+    test_table.insert(:num => nums[0], :created_at => Time.now.utc)
+    test_table.insert(:num => nums[1], :created_at => Time.now.utc)
+    plugin.run(q)
+    test_table.insert(:num => nums[2], :created_at => Time.now.utc)
+    test_table.insert(:num => nums[3], :created_at => Time.now.utc)
+    test_table.insert(:num => nums[4], :created_at => Time.now.utc)
+    plugin.run(q)
+
+    actual_sum = 0
+    until q.empty? do
+      actual_sum += q.pop['num']
+    end
+
+    plugin.teardown
+
+    insist { actual_sum } == nums.inject{|sum,x| sum + x }
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-jdbc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.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
+  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
+  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
+  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
+  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: :development
+  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
+  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
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/inputs/jdbc.rb
+- lib/logstash/plugin_mixins/jdbc.rb
+- logstash-input-jdbc.gemspec
+- spec/inputs/jdbc_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: This example input streams a string at a definable interval.
+test_files:
+- spec/inputs/jdbc_spec.rb