fluent-plugin-mysql 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-mysql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+
+   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,63 @@
+# fluent-plugin-mysql
+
+## Component
+
+### MysqlOutput
+
+Plugin to store mysql tables over SQL, to each columns per values, or to single column as json.
+
+## Configuration
+
+### MysqlOutput
+
+MysqlOutput needs MySQL server's host/port/database/username/password, and INSERT format as SQL, or as table name and columns.
+
+    <match output.by.sql.*>
+      type mysql
+      host master.db.service.local
+      # port 3306 # default
+      database application_logs
+      username myuser
+      password mypass
+      key_names status,bytes,vhost,path,rhost,agent,referer
+      sql INSERT INTO accesslog (status,bytes,vhost,path,rhost,agent,referer) VALUES (?,?,?,?,?,?,?)
+      flush_intervals 5s
+    </match>
+    
+    <match output.by.names.*>
+      type mysql
+      host master.db.service.local
+      database application_logs
+      username myuser
+      password mypass
+      key_names status,bytes,vhost,path,rhost,agent,referer
+      table accesslog
+      # 'columns' names order must be same with 'key_names'
+      columns status,bytes,vhost,path,rhost,agent,referer
+      flush_intervals 5s
+    </match>
+
+Or, insert json into single column.
+
+    <match output.as.json.*>
+      type mysql
+      host master.db.service.local
+      database application_logs
+      username root
+      table accesslog
+      columns jsondata
+      format json
+      flush_intervals 5s
+    </match>
+
+Now, out_mysql cannnot handle tag/time as output data.
+
+## TODO
+
+* implement 'tag_mapped'
+* implement 'time' and 'tag' in key_names
+
+## Copyright
+
+Copyright:: Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+License::   Apache License, Version 2.0

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.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-mysql"
+  gem.version       = "0.0.1"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.description   = %q{fluent plugin to insert mysql as json(single column) or insert statement}
+  gem.summary       = %q{fluent plugin to insert mysql}
+  gem.homepage      = "https://github.com/tagomoris/fluent-plugin-mysql"
+
+  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_development_dependency "fluentd"
+  gem.add_development_dependency "mysql2"
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "mysql2"
+end

data/lib/fluent/plugin/out_mysql.rb

@@ -0,0 +1,123 @@
+class Fluent::MysqlOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('mysql', self)
+
+  config_param :host, :string
+  config_param :port, :integer, :default => nil
+  config_param :database, :string
+  config_param :username, :string
+  config_param :password, :string, :default => ''
+
+  config_param :key_names, :string, :default => nil # nil allowed for json format
+  config_param :sql, :string, :default => nil
+  config_param :table, :string, :default => nil
+  config_param :columns, :string, :default => nil
+
+  config_param :format, :string, :default => "raw" # or json
+
+  attr_accessor :handler
+
+  def initialize
+    super
+    require 'mysql2'
+  end
+
+  def configure(conf)
+    super
+
+    # TODO tag_mapped
+
+    if @format == 'json'
+      # TODO time, tag, and json values
+      @format_proc = Proc.new{|tag, time, record| record.to_json}
+    else
+      # TODO time,tag in key_names
+      @key_names = @key_names.split(',')
+      @format_proc = Proc.new{|tag, time, record| @key_names.map{|k| record[k]}}
+    end
+
+    if @columns.nil? and @sql.nil?
+      raise Fluent::ConfigError, "columns or sql MUST be specified, but missing"
+    end
+    if @columns and @sql
+      raise Fluent::ConfigError, "both of columns and sql are specified, but specify one of them"
+    end
+
+    if @sql
+      begin
+        # using nil to pass call of @handler.escape (@handler is set in #start)
+        if @format == 'json'
+          pseudo_bind(@sql, [nil])
+        else
+          pseudo_bind(@sql, @key_names.map{|n| nil})
+        end
+      rescue ArgumentError => e
+        raise Fluent::ConfigError, "mismatch between sql placeholders and key_names"
+      end
+    else # columns
+      raise Fluent::ConfigError, "table missing" unless @table
+      @columns = @columns.split(',')
+      cols = @columns.join(',')
+      placeholders = if @format == 'json'
+                       '?'
+                     else
+                       @key_names.map{|k| '?'}.join(',')
+                     end
+      @sql = "INSERT INTO #{@table} (#{cols}) VALUES (#{placeholders})"
+    end
+  end
+
+  def start
+    super
+    @handler ||= Mysql2::Client.new({:host => @host, :port => @port,
+                                      :username => @username, :password => @password,
+                                      :database => @database})
+  end
+
+  def shutdown
+    super
+    @handler.close
+  end
+
+  def pseudo_bind(sql, values)
+    sql = sql.dup
+
+    placeholders = []
+    search_pos = 0
+    while pos = sql.index('?', search_pos)
+      placeholders.push(pos)
+      search_pos = pos + 1
+    end
+    raise ArgumentError, "mismatch between placeholders number and values arguments" if placeholders.length != values.length
+
+    while pos = placeholders.pop()
+      rawvalue = values.pop()
+      if rawvalue.nil?
+        sql[pos] = 'NULL'
+      elsif rawvalue.is_a?(Time)
+        val = rawvalue.strftime('%Y-%m-%d %H:%M:%S')
+        sql[pos] = "'" + val + "'"
+      else
+        val = @handler.escape(rawvalue.to_s)
+        sql[pos] = "'" + val + "'"
+      end
+    end
+    sql
+  end
+
+  def query(sql, *values)
+    values = values.flatten
+    # pseudo prepared statements
+    return @handler.query(sql) if values.length < 1
+    @handler.query(self.pseudo_bind(sql, values))
+  end
+
+  def format(tag, time, record)
+    [tag, time, @format_proc.call(tag, time, record)].to_msgpack
+  end
+
+  def write(chunk)
+    chunk.msgpack_each { |tag, time, data|
+      query(@sql, data)
+    }
+  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'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_mysql.rb

@@ -0,0 +1,107 @@
+require 'helper'
+
+class MysqlOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+host db.local
+database testing
+username testuser
+sql INSERT INTO tbl SET jsondata=?
+format json
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    d = Fluent::Test::BufferedOutputTestDriver.new(Fluent::MysqlOutput, tag).configure(conf)
+    obj = Object.new
+    obj.instance_eval {
+      def escape(v)
+        v
+      end
+      def query(*args); [1]; end
+      def close; true; end
+    }
+    d.instance.handler = obj
+    d
+  end
+
+  def test_configure
+    d = create_driver %[
+host database.local
+database foo
+username bar
+sql INSERT INTO baz SET jsondata=?
+format json
+    ]
+    d = create_driver %[
+host database.local
+database foo
+username bar
+table baz
+columns jsondata
+format json
+    ]
+    d = create_driver %[
+host database.local
+database foo
+username bar
+password mogera
+key_names field1,field2,field3
+table baz
+columns col1,col2,col3
+    ]
+    assert_equal 'INSERT INTO baz (col1,col2,col3) VALUES (?,?,?)', d.instance.sql
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+host database.local
+database foo
+username bar
+password mogera
+key_names field1,field2,field3
+sql INSERT INTO baz (col1,col2,col3,col4) VALUES (?,?,?,?)
+      ]
+    }
+  end
+
+  def test_pseudo_bind
+    d = create_driver
+    sql = 'INSERT INTO baz SET col1=?'
+    # assert_equal "INSERT INTO baz SET col1='HOGE'", d.instance.pseudo_bind(sql, ['HOGE'])
+    assert_equal "INSERT INTO baz SET col1=NULL", d.instance.pseudo_bind(sql, [nil])
+    assert_equal "INSERT INTO baz SET col1='2012-04-16 17:38:00'", d.instance.pseudo_bind(sql, [Time.local(2012, 4, 16, 17, 38, 0)])
+  end
+
+  def test_query
+  end
+
+  def test_format
+    d = create_driver
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit({"a"=>1}, time)
+    d.emit({"a"=>2}, time)
+
+    #d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":1}\n]
+    #d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":2}\n]
+    d.expect_format ['test', time, {"a" => 1}.to_json].to_msgpack
+    d.expect_format ['test', time, {"a" => 2}.to_json].to_msgpack
+
+    d.run
+  end
+
+  def test_write
+    # d = create_driver
+
+    # time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    # d.emit({"a"=>1}, time)
+    # d.emit({"a"=>2}, time)
+
+    # ### FileOutput#write returns path
+    # path = d.run
+    # expect_path = "#{TMP_DIR}/out_file_test._0.log.gz"
+    # assert_equal expect_path, path
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mysql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fluent plugin to insert mysql as json(single column) or insert statement
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-mysql.gemspec
+- lib/fluent/plugin/out_mysql.rb
+- test/helper.rb
+- test/plugin/test_out_mysql.rb
+homepage: https://github.com/tagomoris/fluent-plugin-mysql
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: fluent plugin to insert mysql
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mysql.rb