fluent-plugin-mysql 0.0.2 → 0.0.3

data/README.md

@@ -50,14 +50,59 @@ Or, insert json into single column.
       flush_intervals 5s
     </match>
 
-Now, out_mysql cannnot handle tag/time as output data.
+To include time/tag into output, use `include_time_key` and `include_tag_key`, like this:
+
+    <match output.with.tag.and.time.*>
+      type mysql
+      host my.mysql.local
+      database anydatabase
+      username yourusername
+      password secret
+      
+      include_time_key yes
+      ### default `time_format` is ISO-8601
+      # time_format %Y%m%d-%H%M%S
+      ### default `time_key` is 'time'
+      # time_key timekey
+      
+      include_tag_key yes
+      ### default `tag_key` is 'tag'
+      # tag_key tagkey
+      
+      table anydata
+      key_names time,tag,field1,field2,field3,field4
+      sql INSERT INTO baz (coltime,coltag,col1,col2,col3,col4) VALUES (?,?,?,?,?,?)
+    </match>
+
+Or, for json:
+
+    <match output.with.tag.and.time.as.json.*>
+      type mysql
+      host database.local
+      database foo
+      username root
+      
+      include_time_key yes
+      utc   # with UTC timezome output (default: localtime)
+      time_format %Y%m%d-%H%M%S
+      time_key timeattr
+      
+      include_tag_key yes
+      tag_key tagattr
+      table accesslog
+      columns jsondata
+      format json
+    </match>
+    #=> inserted json data into column 'jsondata' with addtional attribute 'timeattr' and 'tagattr'
 
 ## TODO
 
 * implement 'tag_mapped'
-* implement 'time' and 'tag' in key_names
+  * dynamic tag based table selection
 
 ## Copyright
 
-Copyright:: Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
-License::   Apache License, Version 2.0
+* Copyright
+  * Copyright(C) 2012- TAGOMORI Satoshi (tagomoris)
+* License
+  * Apache License, Version 2.0

data/fluent-plugin-mysql.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-mysql"
-  gem.version       = "0.0.2"
+  gem.version       = "0.0.3"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{fluent plugin to insert mysql as json(single column) or insert statement}

data/lib/fluent/plugin/out_mysql.rb

@@ -1,6 +1,9 @@
 class Fluent::MysqlOutput < Fluent::BufferedOutput
   Fluent::Plugin.register_output('mysql', self)
 
+  include Fluent::SetTimeKeyMixin
+  include Fluent::SetTagKeyMixin
+  
   config_param :host, :string
   config_param :port, :integer, :default => nil
   config_param :database, :string
@@ -27,10 +30,8 @@ class Fluent::MysqlOutput < Fluent::BufferedOutput
     # 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
@@ -77,10 +78,16 @@ class Fluent::MysqlOutput < Fluent::BufferedOutput
     [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
+      })
+  end
+
   def write(chunk)
-    handler = Mysql2::Client.new({:host => @host, :port => @port,
-                                   :username => @username, :password => @password,
-                                   :database => @database})
+    handler = self.client
     chunk.msgpack_each { |tag, time, data|
       handler.xquery(@sql, data)
     }

data/test/plugin/test_out_mysql.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'mysql2-cs-bind'
 
 class MysqlOutputTest < Test::Unit::TestCase
   def setup
@@ -15,15 +16,16 @@ 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
+    d.instance.instance_eval {
+      def client
+        obj = Object.new
+        obj.instance_eval {
+          def xquery(*args); [1]; end
+          def close; true; end
+        }
+        obj
       end
-      def query(*args); [1]; end
-      def close; true; end
     }
-    d.instance.handler = obj
     d
   end
 
@@ -81,16 +83,80 @@ sql INSERT INTO baz (col1,col2,col3,col4) VALUES (?,?,?,?)
     d.run
   end
 
-  def test_write
-    # d = create_driver
+  def test_time_and_tag_key
+    d = create_driver %[
+host database.local
+database foo
+username bar
+password mogera
+include_time_key yes
+utc
+include_tag_key yes
+table baz
+key_names time,tag,field1,field2,field3,field4
+sql INSERT INTO baz (coltime,coltag,col1,col2,col3,col4) VALUES (?,?,?,?,?,?)
+    ]
+    assert_equal 'INSERT INTO baz (coltime,coltag,col1,col2,col3,col4) VALUES (?,?,?,?,?,?)', d.instance.sql
+
+    time = Time.parse('2012-12-17 01:23:45 UTC').to_i
+    record = {'field1'=>'value1','field2'=>'value2','field3'=>'value3','field4'=>'value4'}
+    d.emit(record, time)
+    d.expect_format ['test', time, ['2012-12-17T01:23:45Z','test','value1','value2','value3','value4']].to_msgpack
+    d.run
+  end
+
+  def test_time_and_tag_key_complex
+    d = create_driver %[
+host database.local
+database foo
+username bar
+password mogera
+include_time_key yes
+utc
+time_format %Y%m%d-%H%M%S
+time_key timekey
+include_tag_key yes
+tag_key tagkey
+table baz
+key_names timekey,tagkey,field1,field2,field3,field4
+sql INSERT INTO baz (coltime,coltag,col1,col2,col3,col4) VALUES (?,?,?,?,?,?)
+    ]
+    assert_equal 'INSERT INTO baz (coltime,coltag,col1,col2,col3,col4) VALUES (?,?,?,?,?,?)', d.instance.sql
 
-    # time = Time.parse("2011-01-02 13:14:15 UTC").to_i
-    # d.emit({"a"=>1}, time)
-    # d.emit({"a"=>2}, time)
+    time = Time.parse('2012-12-17 09:23:45 JST').to_i # JST(+0900)
+    record = {'field1'=>'value1','field2'=>'value2','field3'=>'value3','field4'=>'value4'}
+    d.emit(record, time)
+    d.expect_format ['test', time, ['20121217-002345','test','value1','value2','value3','value4']].to_msgpack
+    d.run
+  end
 
-    # ### FileOutput#write returns path
-    # path = d.run
-    # expect_path = "#{TMP_DIR}/out_file_test._0.log.gz"
-    # assert_equal expect_path, path
+  def test_time_and_tag_key_json
+    d = create_driver %[
+host database.local
+database foo
+username bar
+password mogera
+include_time_key yes
+utc
+time_format %Y%m%d-%H%M%S
+time_key timekey
+include_tag_key yes
+tag_key tagkey
+table accesslog
+columns jsondata
+format json
+    ]
+    assert_equal 'INSERT INTO accesslog (jsondata) VALUES (?)', d.instance.sql
+
+    time = Time.parse('2012-12-17 09:23:45 JST').to_i # JST(+0900)
+    record = {'field1'=>'value1'}
+    d.emit(record, time)
+    # Ruby 1.9.3 Hash saves its key order, so this code is OK.
+    d.expect_format ['test', time, record.merge({'timekey'=>'20121217-002345','tagkey'=>'test'}).to_json].to_msgpack
+    d.run
+  end
+
+  def test_write
+    # hmm....
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mysql
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd