fluent-plugin-postgres 0.0.1

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/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2013 Uken Games
+
+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,133 @@
+# fluent-plugin-postgres
+
+
+## Changes from mysql:
+
+- We currently don't suppor json format
+- You need to specify a SQL query
+- Placeholders are numbered (yeah, I know).
+
+Other than that, just bear in mind that it's Postgres SQL.
+
+### Quick example
+
+    <match output.by.sql.*>
+      type postgres
+      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 ($1,$2,$3,$4,$5,$6,$7)
+      flush_intervals 5s
+    </match>
+
+
+
+## Component
+
+### PostgresOutput
+
+Plugin to store Postgres 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>
+
+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'
+  * dynamic tag based table selection
+
+## Copyright
+
+* Copyright
+  * Copyright 2013 Uken Games
+* 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-postgres.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name          = 'fluent-plugin-postgres'
+  s.version       = '0.0.1'
+  s.authors       = ['TAGOMORI Satoshi', 'Diogo Terror', 'pitr']
+  s.email         = ['team@uken.com']
+  s.description   = %q{fluent plugin to insert on PostgreSQL}
+  s.summary       = %q{fluent plugin to insert on PostgreSQL}
+  s.homepage      = 'https://github.com/uken/fluent-plugin-postgres'
+  s.license       = 'Apache 2.0'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'fluentd'
+  s.add_dependency 'pg'
+
+  s.add_development_dependency 'rake'
+end

data/lib/fluent/plugin/out_postgres.rb

@@ -0,0 +1,74 @@
+class Fluent::PostgresOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('postgres', self)
+
+  include Fluent::SetTimeKeyMixin
+  include Fluent::SetTagKeyMixin
+
+  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 'pg'
+  end
+
+  # We don't currently support mysql's analogous json format
+  def configure(conf)
+    super
+
+    if @format == 'json'
+      @format_proc = Proc.new{|tag, time, record| record.to_json}
+    else
+      @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
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def format(tag, time, record)
+    [tag, time, @format_proc.call(tag, time, record)].to_msgpack
+  end
+
+  def client
+    PG::Connection.new({
+      :host => @host, :port => @port,
+      :user => @username, :password => @password,
+      :dbname => @database
+    })
+  end
+
+  def write(chunk)
+    handler = self.client
+    handler.prepare("write", @sql)
+    chunk.msgpack_each { |tag, time, data|
+      handler.exec_prepared("write", data)
+    }
+    handler.close
+  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_postgres'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_postgres.rb

@@ -0,0 +1,107 @@
+require 'helper'
+require 'pg'
+
+class PostgresOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+host database.local
+database foo
+username bar
+password mogera
+key_names field1,field2,field3
+sql INSERT INTO baz (col1,col2,col3,col4) VALUES (?,?,?,?)
+  ]
+
+  def create_driver(conf=CONFIG, tag='test')
+    d = Fluent::Test::BufferedOutputTestDriver.new(Fluent::PostgresOutput, tag).configure(conf)
+    d.instance.instance_eval {
+      def client
+        obj = Object.new
+        obj.instance_eval {
+          def prepare(*args); true; end
+        def exec_prepared(*args); true; end
+        def close; true; end
+        }
+        obj
+      end
+    }
+    d
+  end
+
+  def test_configure_fails_if_both_cols_and_sql_specified
+    assert_raise(Fluent::ConfigError) {
+      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 (?,?,?,?)
+columns col1,col2,col3,col4
+      ]
+    }
+  end
+
+  def test_configure_fails_if_neither_cols_or_sql_specified
+    assert_raise(Fluent::ConfigError) {
+      create_driver %[
+host database.local
+database foo
+username bar
+password mogera
+key_names field1,field2,field3
+      ]
+    }
+  end
+
+  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.utc(2012,12,17,1,23,45).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.new(2012,12,17,9,23,45,'+09:00').to_i
+    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
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-postgres
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+- Diogo Terror
+- pitr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-11 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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: rake
+  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'
+description: fluent plugin to insert on PostgreSQL
+email:
+- team@uken.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-postgres.gemspec
+- lib/fluent/plugin/out_postgres.rb
+- test/helper.rb
+- test/plugin/test_out_postgres.rb
+homepage: https://github.com/uken/fluent-plugin-postgres
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4318069174566996150
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4318069174566996150
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: fluent plugin to insert on PostgreSQL
+test_files:
+- test/helper.rb
+- test/plugin/test_out_postgres.rb