logstash-filter-jdbc 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbd156b8cd6dbdd977575f47331cddd69a8c85e5
+  data.tar.gz: 1bc4f90f12e3c4cb2a0f3bd40ece7abad49fbf1c
+SHA512:
+  metadata.gz: 61554b48417126c424bff92340575f16f67fd06b3284fd4b434e8694d577ac5050d43bc626c303d6c2ba5513f8949c5367de21a2ea269f0ab40c5248ab7b9ac1
+  data.tar.gz: d7d314c6012188fe20f386164781e32ac977826c09f903c62f1b7e74cb771479bb9ea9ff9e9d5b8b428bb9487e3b5cc949bbda6fcd11239c235cab714c0bf90b

data/DEVELOPMENT.md

@@ -0,0 +1,14 @@
+# About mixin definition
+
+Whether it is for input/filter/output, communicating with a database through JDBC should be very similar as it would require common capabilities:
+
+* connection pool
+* transaction
+* ...
+
+but it can be implemented with different libraries:
+
+* Ruby: Sequel, Activerecords,...
+* Java: Plain JDBC, Apache commons- DBCP, c3p0 ...
+
+This filter contains a mixin proposal based on Sequel

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+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,100 @@
+# Work in progress
+
+This plugin is a work in progress.
+Please see DEVELOPMENT.md for more information.
+
+# Logstash Plugin
+
+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-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+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-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.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/lib/logstash/filters/jdbc.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "logstash/plugin_mixins/jdbc"
+
+# This filter executes a SQL query and store the result set in the field 
+# specified as `target`.
+#
+# For example you can load a row based on an id from in the event
+#
+# [source,ruby]
+# filter {
+#   jdbc {
+#     jdbc_driver_library => "/path/to/mysql-connector-java-5.1.34-bin.jar"
+#     jdbc_driver_class => "com.mysql.jdbc.Driver"
+#     jdbc_connection_string => ""jdbc:mysql://localhost:3306/mydatabase"
+#     jdbc_user => "me"
+#     jdbc_password => "secret"
+#     statement => "select * from WORLD.COUNTRY WHERE Code = :code"
+#     parameters => { "code" => "country_code"}
+#     target => "country_details"
+#   }
+# }
+#
+class LogStash::Filters::Jdbc < LogStash::Filters::Base
+  include LogStash::PluginMixins::Jdbc
+  config_name "jdbc"
+
+  # Statement to execute.
+  # To use parameters, use named parameter syntax, for example "SELECT * FROM MYTABLE WHERE ID = :id"
+  config :statement, :validate => :string, :required => true 
+
+  # Hash of query parameter, for example `{ "id" => "id_field" }`
+  config :parameters, :validate => :hash, :default => {}
+
+  # Target field to store the result set.
+  # Field is overwritten if exists.
+  config :target, :validate => :string, :required => true 
+
+  # Append values to the `tags` field if sql error occured
+  config :tag_on_failure, :validate => :array, :default => ["_jdbcfailure"] 
+
+
+  public
+  def register
+    prepare_jdbc_connection()
+  end # def register
+
+  public
+  def filter(event)
+    result = []
+    #Prepare parameters from event values
+    params = @parameters.inject({}) {|hash,(k,v)| hash[k] = event[event.sprintf(v)] ; hash }
+    #Execute statement and collect results
+    success = execute_statement(@statement,params) do |row|
+      result << row
+    end
+    if success
+      event[@target] = result
+      filter_matched(event)
+    else
+      @tag_on_failure.each do |tag|
+        event["tags"] ||= []
+        event["tags"] << tag unless event["tags"].include?(tag)
+      end
+    end
+  end # def filter
+end # class LogStash::Filters::Jdbc

data/lib/logstash/plugin_mixins/jdbc.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+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
+  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
+
+    # 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 "sequel"
+    require "sequel/adapters/jdbc"
+    require "java"
+    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 execute_statement(statement, parameters)
+    success = false
+    begin 
+      #Symbolize parameters keys to use with Sequel
+      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
+      query = @database[statement,parameters]
+      @logger.debug? and @logger.debug("Executing JDBC query", :statement => statement, :parameters => parameters)
+      query.all do |row|
+        #Stringify row keys
+        yield row.inject({}){|hash,(k,v)| hash[k.to_s] = v; hash}
+      end
+      success = true
+    rescue Sequel::DatabaseConnectionError, Sequel::DatabaseError => e
+      @logger.warn("Exception when executing JDBC query", :exception => e)
+    end
+    return success
+  end
+end

data/logstash-filter-jdbc.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-jdbc'
+  s.version         = '0.1.2'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This filter executes a SQL query and store the result set in the event."
+  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 = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+   # 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" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 2.0.0.beta2', '< 5.0.0'
+  s.add_runtime_dependency 'sequel'
+  
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'jdbc-derby'
+end

data/spec/filters/jdbc_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require "logstash/filters/jdbc"
+require 'jdbc/derby'
+describe LogStash::Filters::Jdbc do
+  #Use embedded Derby for tests
+  Jdbc::Derby.load_driver
+
+  describe "All default - Retrieve a value from database" do
+    let(:config) do <<-CONFIG
+      filter {
+        jdbc {
+          jdbc_driver_class => "org.apache.derby.jdbc.EmbeddedDriver"
+          jdbc_connection_string => "jdbc:derby:memory:testdb;create=true"
+          statement => "SELECT 'from_database' FROM SYSIBM.SYSDUMMY1"
+          target => "new_field"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject['new_field']).to eq([{"1" => 'from_database'}])
+    end
+  end
+
+  describe "Named column - Retrieve a value from database" do
+    let(:config) do <<-CONFIG
+      filter {
+        jdbc {
+          jdbc_driver_class => "org.apache.derby.jdbc.EmbeddedDriver"
+          jdbc_connection_string => "jdbc:derby:memory:testdb;create=true"
+          statement => "SELECT 'from_database' as col_1 FROM SYSIBM.SYSDUMMY1"
+          target => "new_field"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject['new_field']).to eq([{"col_1" => 'from_database'}])
+    end
+  end
+
+  describe "Using string parameters - Retrieve a value from database" do
+    let(:config) do <<-CONFIG
+      filter {
+        jdbc {
+          jdbc_driver_class => "org.apache.derby.jdbc.EmbeddedDriver"
+          jdbc_connection_string => "jdbc:derby:memory:testdb;create=true"
+          statement => "SELECT 'from_database' FROM SYSIBM.SYSDUMMY1 WHERE '1' = :param"
+          parameters => { "param" => "param_field"}
+          target => "new_field"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text", "param_field" => "1") do
+      expect(subject['new_field']).to eq([{"1" => 'from_database'}])
+    end
+
+    sample("message" => "some text", "param_field" => "2") do
+      expect(subject['new_field'].nil?)
+    end
+  end
+
+  describe "Using integer parameters" do
+    let(:config) do <<-CONFIG
+      filter {
+        jdbc {
+          jdbc_driver_class => "org.apache.derby.jdbc.EmbeddedDriver"
+          jdbc_connection_string => "jdbc:derby:memory:testdb;create=true"
+          statement => "SELECT 'from_database' FROM SYSIBM.SYSDUMMY1 WHERE 1 = :param"
+          parameters => { "param" => "param_field"}
+          target => "new_field"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text", "param_field" => 1) do
+      expect(subject['new_field']).to eq([{"1" => 'from_database'}])
+    end
+
+    sample("message" => "some text", "param_field" => "1") do
+      expect(subject['new_field'].nil?)
+    end
+  end
+
+  describe "Using timestamp parameter" do
+    let(:config) do <<-CONFIG
+      filter {
+        jdbc {
+          jdbc_driver_class => "org.apache.derby.jdbc.EmbeddedDriver"
+          jdbc_connection_string => "jdbc:derby:memory:testdb;create=true"
+          statement => "SELECT 'from_database' FROM SYSIBM.SYSDUMMY1 WHERE {fn TIMESTAMPDIFF( SQL_TSI_DAY, {t :param}, current_timestamp)} = 0"
+          parameters => { "param" => "@timestamp"}
+          target => "new_field"
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject['new_field']).to eq([{"1" => 'from_database'}])
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-jdbc
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.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: 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:
+- DEVELOPMENT.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/jdbc.rb
+- lib/logstash/plugin_mixins/jdbc.rb
+- logstash-filter-jdbc.gemspec
+- spec/filters/jdbc_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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.4.8
+signing_key:
+specification_version: 4
+summary: This filter executes a SQL query and store the result set in the event.
+test_files:
+- spec/filters/jdbc_spec.rb
+- spec/spec_helper.rb