fluent-plugin-rds-genlog 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6791b993428fe080313f2bbc4ae4a41ace460b0
+  data.tar.gz: 6618063d54c45e2a996998e3de606556ccb89dbb
+SHA512:
+  metadata.gz: c649ba4f4ec43197d6cb5160e90fcc9527631eb7563818e1ae6d89745bb759f9356a3dfe8ac5b10fcbb140cc9f43a1a6108fa2450b14a4c128606e943fd33739
+  data.tar.gz: 7002a8c9d2ba7556a0b16f8f40ae1cb7288b7875902ddbe39a9bb56f2b9030945b1baf9305905223f20296a848394660b2f00aa9be12ae8531ada21913c73142

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+ - 2.2
+ - jruby
+ - rbx-2
+# uncomment and edit the following line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jen LaGrutta
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kenjiskywalker
+
+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,68 @@
+# This plugin was made based off the slowlog plugin code.  This new plugin fluent-plugin-rds-genlog [![Build Status](https://travis-ci.org/jenlagrutta/fluent-plugin-rds-genlog.png)](https://travis-ci.org/jenlagrutta/fluent-plugin-rds-genlog/)
+
+
+## RDS Setting
+
+[Working with MySQL Database Log Files / aws documentation](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.MySQL.html)
+
+- Set the `general_log` parameter to `1`
+
+## Overview
+***AWS RDS general_log*** input plugin.
+
+1. **"CALL mysql.rds_rotate_general_log"**
+2. **"SELECT * FROM general_log_backup"**
+3. **"INSERT INTO yourdb.general_log_custom_backup SELECT * FROM general_log_backup"** (if you want to take a backup)
+
+every 10 seconds from AWS RDS.
+
+## Configuration
+
+```config
+<source>
+  type rds_genlog
+  tag rds-genlog
+  host [RDS Hostname]
+  username [RDS Username]
+  password [RDS Password]
+  backup_table [Your Backup Tablename]
+</source>
+```
+
+### Example GET RDS general_log
+
+```config
+<source>
+  type rds_genlog
+  tag rds-genlog
+  host [RDS Hostname]
+  username [RDS Username]
+  password [RDS Password]
+  interval 10
+  backup_table [Your Backup Tablename]
+</source>
+
+<match rds-genlog>
+  type copy
+ <store>
+  type file
+  path /var/log/general_log
+ </store>
+</match>
+```
+
+#### output data format
+
+```
+2013-03-08T16:04:43+09:00       rds-genlog     {"start_time":"2013-03-08 07:04:38","user_host":"rds_db[rds_db] @  [192.0.2.10]","event_time":"00:00:00","command_type":"QUERY", "server_id":"100000000","argument":"select foo from bar"}
+2013-03-08T16:04:43+09:00       rds-genlog     {"start_time":"2013-03-08 07:04:38","user_host":"rds_db[rds_db] @  [192.0.2.10]","event_time":"00:00:00","command_type":"QUERY", "server_id":"100000000","argument":"select sleep(2)"}
+```
+
+#### if not connect
+
+- td-agent.log
+
+```
+2013-06-29 00:32:55 +0900 [error]: fluent-plugin-rds-genlog: cannot connect RDS
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/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-rds-genlog.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-rds-genlog"
+  gem.version       = "0.0.9"
+  gem.authors       = ["lagrutta", "jen"]
+  gem.email         = ["jen@tune.com"]
+  gem.description   = "Amazon RDS gen_log input plugin for Fluent event collector"
+  gem.homepage      = "https://github.com/hasjenL/fluent-plugin-rds-genlog"
+  gem.summary       = gem.description
+  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"]
+
+  if RUBY_VERSION > '2.0.0'
+    gem.add_dependency "fluentd"
+  elsif RUBY_VERSION > '1.9.2'
+    gem.add_dependency "fluentd", "~> 0.12.29"
+  else
+    gem.add_dependency "fluentd", "<= 0.10.55"
+  end
+
+  if RUBY_VERSION <= '2.0.0'
+    gem.add_dependency "json", "< 2"
+  end
+
+  if RUBY_VERSION <= '1.9.2'
+    gem.add_development_dependency "rake", "<= 11"
+  else
+    gem.add_development_dependency "rake", ">= 10.0.4"
+  end
+
+  gem.add_dependency "mysql2",  "~> 0.3.11"
+  gem.add_development_dependency "test-unit", "~> 3.1.3"
+  gem.add_development_dependency "timecop"
+end

data/lib/fluent/plugin/in_rds_genlog.rb

@@ -0,0 +1,112 @@
+require 'fluent/input'
+
+class Fluent::Rds_GenlogInput < Fluent::Input
+  Fluent::Plugin.register_input("rds_genlog", self)
+
+  # To support log_level option implemented by Fluentd v0.10.43
+  unless method_defined?(:log)
+    define_method("log") { $log }
+  end
+
+  # Define `router` method of v0.12 to support v0.10 or earlier
+  unless method_defined?(:router)
+    define_method("router") { Fluent::Engine }
+  end
+
+  config_param :tag,          :string
+  config_param :host,         :string,  :default => nil
+  config_param :port,         :integer, :default => 3306
+  config_param :username,     :string,  :default => nil
+  config_param :password,     :string,  :default => nil, :secret => true
+  config_param :interval,     :integer, :default => 10
+  config_param :backup_table, :string,  :default => nil
+
+  def initialize
+    super
+    require 'mysql2'
+  end
+
+  def configure(conf)
+    super
+    begin
+      @client = create_mysql_client
+    rescue
+      log.error "fluent-plugin-rds-genlog: cannot connect RDS"
+    end
+  end
+
+  def start
+    super
+    if @backup_table
+      @client.query("CREATE TABLE IF NOT EXISTS #{@backup_table} LIKE general_log")
+    end
+
+    @loop = Coolio::Loop.new
+    timer = TimerWatcher.new(@interval, true, log, &method(:output))
+    @loop.attach(timer)
+    @watcher = Thread.new(&method(:watch))
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  private
+  def watch
+    @loop.run
+  rescue => e
+    log.error(e.message)
+    log.error_backtrace(e.backtrace)
+  end
+
+  def output
+    @client.query('CALL mysql.rds_rotate_general_log')
+
+    gen_log_data = []
+    gen_log_data = @client.query('SELECT * FROM general_log_backup', :cast => false)
+
+    gen_log_data.each do |row|
+      row.each_key {|key| row[key].force_encoding(Encoding::ASCII_8BIT) if row[key].is_a?(String)}
+      router.emit(tag, Fluent::Engine.now, row)
+    end
+
+    if @backup_table
+      @client.query("INSERT INTO #{@backup_table} SELECT * FROM general_log_backup")
+    end
+  rescue Mysql2::Error => e
+    @log.error(e.message)
+    @log.error_backtrace(e.backtrace)
+
+    unless @client.ping
+      @log.info('fluent-plugin-rds-genlog: try to reconnect to RDS')
+      @client = create_mysql_client
+    end
+  end
+
+  def create_mysql_client
+    Mysql2::Client.new({
+      :host => @host,
+      :port => @port,
+      :username => @username,
+      :password => @password,
+      :database => 'mysql'
+    })
+  end
+
+  class TimerWatcher < Coolio::TimerWatcher
+    def initialize(interval, repeat, log, &callback)
+      @callback = callback
+      @log = log
+      super(interval, repeat)
+    end
+
+    def on_timer
+      @callback.call
+    rescue => e
+      @log.error(e.message)
+      @log.error_backtrace(e.backtrace)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,32 @@
+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"
+require "mysql2"
+require "timecop"
+
+$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/in_rds_genlog"
+
+class Test::Unit::TestCase
+end
+

data/test/plugin/test_in_rds_genlog.rb

@@ -0,0 +1,143 @@
+require 'helper'
+
+class Rds_GenlogInputTest < Test::Unit::TestCase
+  class << self
+    def startup
+      setup_database
+      Timecop.freeze(Time.parse('2015/05/24 18:30 UTC'))
+    end
+
+    def shutdown
+      cleanup_database
+    end
+
+    def setup_database
+      client = mysql2_client
+      client.query("GRANT ALL ON *.* TO test_rds_user@localhost IDENTIFIED BY 'test_rds_password'")
+
+      client.query <<-EOS
+        CREATE PROCEDURE `mysql`.`rds_rotate_general_log`()
+        BEGIN
+          DECLARE sql_logging BOOLEAN;
+          select @@sql_log_bin into sql_logging;
+          set @@sql_log_bin=off;
+          CREATE TABLE IF NOT EXISTS mysql.general_log2 LIKE mysql.general_log;
+
+          #{insert_general_log_sql}
+
+          DROP TABLE IF EXISTS mysql.general_log_backup;
+          RENAME TABLE mysql.geneal_log TO mysql.general_log_backup, mysql.general_log2 TO mysql.general_log;
+          set @@sql_log_bin=sql_logging;
+        END
+      EOS
+    end
+
+    def cleanup_database
+      client = mysql2_client
+      client.query("DROP USER test_rds_user@localhost")
+      client.query("DROP PROCEDURE `mysql`.`rds_rotate_general_log`")
+      client.query("DROP TABLE `mysql`.`general_log_custom_backup`")
+    end
+
+    def insert_general_log_sql
+      if has_thread_id?
+        <<-EOS
+          INSERT INTO `mysql`.`general_log2` (
+            `event_time`, `user_host`, `command_type`, `server_id`, `argument`, `thread_id`)
+          VALUES
+            ('2015-09-29 15:43:44', 'root@localhost', 'QUERY', 1, 'SELECT 1', 0), 
+            ('2015-09-29 15:43:45', 'root@localhost', 'QUERY', 1, 'SELECT 2', 0);
+        EOS
+      else
+        <<-EOS
+          INSERT INTO `mysql`.`general_log2` (
+            `event_time`, `user_host`, `command_type`, `server_id`, `argument`, `thread_id`)
+          VALUES
+            ('2015-09-29 15:43:44', 'root@localhost', 'QUERY', 1, 'SELECT 1', 0)
+           ,('2015-09-29 15:43:45', 'root@localhost', 'QUERY', 1, 'SELECT 2', 0)
+          ;
+        EOS
+      end
+    end
+
+    def has_thread_id?
+      client = mysql2_client
+      fields = client.query("SHOW FULL FIELDS FROM `mysql`.`general_log`").map {|r| r['Field'] }
+      fields.include?('thread_id')
+    end
+
+    def mysql2_client
+      Mysql2::Client.new(:username => 'root')
+    end
+  end
+
+  def rotate_general_log
+    client = self.class.mysql2_client
+    client.query("CALL `mysql`.`rds_rotate_general_log`")
+  end
+
+  def setup
+    Fluent::Test.setup
+    rotate_general_log
+  end
+
+  CONFIG = %[
+    tag rds-genlog
+    host localhost
+    username test_rds_user
+    password test_rds_password
+    interval 0
+    backup_table mysql.general_log_custom_backup
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::InputTestDriver.new(Fluent::Rds_GenlogInput).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 'rds-genlog', d.instance.tag
+    assert_equal 'localhost', d.instance.host
+    assert_equal 'test_rds_user', d.instance.username
+    assert_equal 'test_rds_password', d.instance.password
+    assert_equal 0, d.instance.interval
+    assert_equal 'mysql.general_log_custom_backup', d.instance.backup_table
+  end
+
+  def test_output
+    d = create_driver
+    d.run
+    records = d.emits
+
+    unless self.class.has_thread_id?
+      records.each {|r| r[2]["thread_id"] = "0" }
+    end
+
+    assert_equal [
+      ["rds-genlog", 1432492200, {"even_time"=>"2015-09-29 15:43:44", "user_host"=>"root@localhost", "command_type"=>"QUERY", "server_id"=>"1", "argument"=>"SELECT 1", "thread_id"=>"0"}],
+      ["rds-genlog", 1432492200, {"even_time"=>"2015-09-29 15:43:44", "user_host"=>"root@localhost", "command_type"=>"QUERY", "server_id"=>"1", "argument"=>"SELECT 2", "thread_id"=>"0"}],
+    ], records
+  end
+
+  def test_backup
+    d = create_driver
+    d.run
+
+    records = []
+    client = self.class.mysql2_client
+    general_logs = client.query('SELECT * FROM `mysql`.`general_log_custom_backup`', :cast => false)
+    general_logs.each do |row|
+      row.each_key {|key| row[key].force_encoding(Encoding::ASCII_8BIT) if row[key].is_a?(String)}
+      records.push(row)
+    end
+
+    unless self.class.has_thread_id?
+      records.each {|r| r["thread_id"] = "0" }
+    end
+
+    assert_equal [
+      {"start_time"=>"2015-09-29 15:43:44", "user_host"=>"root@localhost", "command_type"=>"QUERY", "server_id"=>"1", "argument"=>"SELECT 1", "thread_id"=>"0"},
+      {"start_time"=>"2015-09-29 15:43:45", "user_host"=>"root@localhost", "command_type"=>"QUERY", "server_id"=>"1", "argument"=>"SELECT 2", "thread_id"=>"0"},
+    ], records
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-rds-genlog
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+platform: ruby
+authors:
+- lagrutta
+- jen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-15 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Amazon RDS gen_log input plugin for Fluent event collector
+email:
+- jen@tune.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-rds-genlog-0.0.8.gem
+- fluent-plugin-rds-genlog.gemspec
+- lib/fluent/plugin/in_rds_genlog.rb
+- test/helper.rb
+- test/plugin/test_in_rds_genlog.rb
+homepage: https://github.com/hasjenL/fluent-plugin-rds-genlog
+licenses: []
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Amazon RDS gen_log input plugin for Fluent event collector
+test_files:
+- test/helper.rb
+- test/plugin/test_in_rds_genlog.rb