fluent-plugin-mysql-prepared-statement 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37ea1313b1c63e4709f63a66b64872c119fbd0c0
+  data.tar.gz: c47c9aca3bb7cfff68215769acb2ae4a8e82117a
+SHA512:
+  metadata.gz: 0e8e7846a2f4b3d3e798a174c99b7dbca48baf30199af91442af1ef2a109b6ce25699f061cc2825835b4c54f91a10ae95b5352faa35510cda15cff0ab95dffa5
+  data.tar.gz: 98d1d3520c5a4ac8241df342e6de8c925baa8307d52405a6aec07547e561aa37e91c2688a5cd35f45f30ba032e2ae2000063b72acf3eabd29fd1b1a0e573b8c3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.conf

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile
+script: "rake test"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hiroshi Toyama
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+[![Build Status](https://secure.travis-ci.org/toyama0919/fluent-plugin-mysql-prepared-statement.png?branch=master)](http://travis-ci.org/toyama0919/fluent-plugin-mysql-prepared-statement)
+
+# fluent-plugin-mysql-prepared-statement
+
+fluent plugin mysql prepared statement query
+
+## Installation
+
+### td-agent(Linux)
+
+    /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mysql-prepared-statement
+
+### td-agent(Mac)
+
+    sudo /usr/local/Cellar/td-agent/1.1.XX/bin/fluent-gem install fluent-plugin-mysql-prepared-statement
+
+### fluentd only
+
+    gem install fluent-plugin-mysql-prepared-statement
+
+
+## Parameters
+
+param|value
+--------|------
+output_tag|output tag(require)
+host|database host(default: 127.0.0.1)
+port|database port(default: 3306)
+database|database name(require)
+username|user(require)
+password|password(default: blank)
+key_names|prepared statement value(require)
+sql|running sql , prepared statement query(require)
+
+## Configuration Example
+
+```
+<match mysql.input>
+  type mysql_prepared_statement
+  output_tag mysql.output
+  host localhost
+  database test_app_development
+  username root
+  password hogehoge
+  key_names id,user_name
+  sql select * from users where id = ? and user_name = ?
+  flush_interval 10s
+</match>
+```
+
+Assume following input is coming:
+
+```js
+mysql.input {"id":"1", "user_name":"toyama"}
+```
+
+then output becomes as below (indented):
+
+```js
+mysql.output {"id":122,"user_name":"toyama","created_at":"2014-01-01 19:10:27 +0900","updated_at":"2014-01-01 19:10:27 +0900"}
+```
+
+running query =>[select * from users where id = 1 and user_name = 'toyama']
+
+
+## spec
+
+```
+rake test
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 Hiroshi Toyama. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-mysql-prepared-statement.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-mysql-prepared-statement"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Toyama Hiroshi"]
+  gem.email         = ["toyama0919@gmail.com"]
+  gem.description   = %q{fluent plugin mysql prepared statement}
+  gem.summary       = %q{fluent plugin mysql prepared statement}
+  gem.homepage      = "https://github.com/toyama0919/fluent-plugin-mysql-prepared-statement"
+  gem.licenses    = ["MIT"]
+  gem.has_rdoc    = false
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "mysql2-cs-bind"
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "spork"
+  gem.add_development_dependency "pry"
+
+end

data/lib/fluent/plugin/out_mysql_prepared_statement.rb

@@ -0,0 +1,90 @@
+# -*- encoding : utf-8 -*-
+module Fluent
+  class Fluent::MysqlPreparedStatementOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('mysql_prepared_statement', self)
+
+    config_param :host, :string, :default => "127.0.0.1"
+    config_param :output_tag, :string
+    config_param :port, :integer, :default => 3306
+    config_param :database, :string
+    config_param :username, :string
+    config_param :password, :string, :default => ''
+
+    config_param :key_names, :string, :default => nil
+    config_param :sql, :string, :default => nil
+
+    attr_accessor :handler
+
+    def initialize
+      super
+      require 'mysql2-cs-bind'
+    end
+
+    def configure(conf)
+      super
+
+      if @sql.nil?
+        raise Fluent::ConfigError, "sql MUST be specified, but missing"
+      end
+
+      if @key_names.nil?
+        raise Fluent::ConfigError, "key_names MUST be specified, but missing"
+      end
+
+      @key_names = @key_names.split(',')
+      @format_proc = Proc.new{|tag, time, record| @key_names.map{|k| record[k]}}
+
+      begin
+        Mysql2::Client.pseudo_bind(@sql, @key_names.map{|n| nil})
+      rescue ArgumentError => e
+        raise Fluent::ConfigError, "mismatch between sql placeholders and key_names"
+      end
+
+      $log.info "sql ->[#{@sql}]"
+    end
+
+    def start
+      @handler = client
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      [tag, time, @format_proc.call(tag, time, record)].to_msgpack
+    end
+
+    def client
+      Mysql2::Client.new({
+          :host => @host,
+          :port => @port,
+          :username => @username,
+          :password => @password,
+          :database => @database,
+          :flags => Mysql2::Client::MULTI_STATEMENTS
+        })
+    end
+
+    def write(chunk)
+      $log.info "adding mysql_query job: "
+      chunk.msgpack_each { |tag, time, data|
+        results = get_exec_result(data)
+        results.each{|result|
+          Fluent::Engine.emit(@output_tag, Fluent::Engine.now, result)
+        }
+      }
+    end
+
+    def get_exec_result(data)
+      results = Array.new
+      stmt = @handler.xquery(@sql, data)
+      return results if stmt.nil?
+      stmt.each do |row|
+        results.push(row)
+      end
+      return results
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_mysql_prepared_statement'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_mysql_prepared_statement.rb

@@ -0,0 +1,107 @@
+require 'helper'
+require 'mysql2-cs-bind'
+
+class MysqlPreparedStatementOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MysqlPreparedStatementOutput, tag).configure(conf)
+  end
+
+  def test_configure_error
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        host localhost
+        username root
+        password hogehoge
+        key_names id,user_name
+        sql select * from users where id = ? and user_name = ?
+        flush_interval 10s
+      ]
+    }
+
+    # not username
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        host localhost
+        password hogehoge
+        key_names id,user_name
+        sql select * from users where id = ? and user_name = ?
+        flush_interval 10s
+      ]
+    }
+  end
+
+  def test_configure
+    # not define format(default csv)
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        host localhost
+        database test_app_development
+        username root
+        password hogehoge
+        key_names id,user_name
+        sql select * from users where id = ? and user_name = ?
+        flush_interval 10s
+      ]
+    }
+
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        host localhost
+        database test_app_development
+        username root
+        password hogehoge
+        key_names id,user_name
+        sql select * from users where id = ? and user_name = ?
+        flush_interval 10s
+      ]
+    }
+
+    assert_nothing_raised(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        database test_app_development
+        username root
+        key_names id,user_name
+        sql select * from users where id = ? and user_name = ?
+      ]
+    }
+  end
+
+  def test_query_error
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        host localhost
+        database rails_development
+        username root
+        password hogehoge
+        key_names id
+        sql select * from users where id = ? and user_name = ?
+        flush_interval 10s
+      ]
+    }
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        output_tag mysql.placeholder
+        host localhost
+        database rails_development
+        username root
+        password hogehoge
+        key_names id,user_name
+        sql select * from users where id = ?
+        flush_interval 10s
+      ]
+    }
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mysql-prepared-statement
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toyama Hiroshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2-cs-bind
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fluent plugin mysql prepared statement
+email:
+- toyama0919@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-mysql-prepared-statement.gemspec
+- lib/fluent/plugin/out_mysql_prepared_statement.rb
+- test/helper.rb
+- test/plugin/test_out_mysql_prepared_statement.rb
+homepage: https://github.com/toyama0919/fluent-plugin-mysql-prepared-statement
+licenses:
+- MIT
+metadata: {}
+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.2.0
+signing_key: 
+specification_version: 4
+summary: fluent plugin mysql prepared statement
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mysql_prepared_statement.rb