fluent-plugin-rds-mysql-slow-log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36fa45a004f050662ff15c1873fd7293f357eca0
+  data.tar.gz: 2f213f061c22154b832206bddfc202c08a1afd0c
+SHA512:
+  metadata.gz: 16a03a50674bf7eed453d223af75257a4409c188ed65b9d7d1692892949823d0919559dc012c6f33c9984a106b868c1eba1dd22e3056da6e1a5cba2600eb6fb7
+  data.tar.gz: ecef8575d6ce05d0e7782199feb89e4b01eae80469775d8f633b88cc545d2ebeee3398f943e573cc84aa1d159e07fe85333a909da0f2785e040dd2033f75e482

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+Style/GuardClause:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.1.10

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Satoshi Matsumoto
+
+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,65 @@
+# fluent-plugin-rds-mysql-slow-log
+
+[![Gem](https://img.shields.io/gem/v/fluent-plugin-rds-mysql-slow-log.svg?style=flat-square)](https://rubygems.org/gems/fluent-plugin-rds-mysql-slow-log)
+[![Gemnasium](https://img.shields.io/gemnasium/kaorimatz/fluent-plugin-rds-mysql-slow-log.svg?style=flat-square)](https://gemnasium.com/kaorimatz/fluent-plugin-rds-mysql-slow-log)
+
+Fluentd input plugin for MySQL slow query log table on Amazon RDS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-rds-mysql-slow-log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-rds-mysql-slow-log
+
+## Usage
+
+```
+<source>
+  @type rds_mysql_slow_log
+  database_timezone Asia/Tokyo
+  emit_interval 30
+  encoding utf-8
+  from_encoding shift_jis
+  keep_time_key
+  null_empty_string
+  tag_prefix slow_log
+  <server>
+    host db1.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com
+    port 3306
+    username user
+    password xxxxxxxxxxxx
+    tag db1
+  </server>
+  <server>
+    host db2.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com
+    port 3306
+    username user
+    password xxxxxxxxxxxx
+    tag db2
+  </server>
+</source>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in the gemspec, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaorimatz/fluent-plugin-rds-mysql-slow-log.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fluent/plugin/in_rds_mysql_slow_log'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-rds-mysql-slow-log.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent-plugin-rds-mysql-slow-log'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Satoshi Matsumoto']
+  spec.email         = ['kaorimatz@gmail.com']
+
+  spec.summary       = 'Fluentd input plugin for MySQL slow query log table on Amazon RDS'
+  spec.description   = 'Fluentd input plugin for MySQL slow query log table on Amazon RDS.'
+  spec.homepage      = 'https://github.com/kaorimatz/fluent-plugin-rds-mysql-slow-log'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fluentd', '>= 0.10.58'
+  spec.add_dependency 'mysql2'
+  spec.add_dependency 'tzinfo'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/fluent/plugin/in_rds_mysql_slow_log.rb

@@ -0,0 +1,223 @@
+require 'cool.io'
+require 'fluent/input'
+require 'mysql2'
+require 'scanf'
+require 'time'
+
+module Fluent
+  class RdsMysqlSlowLog < Input
+    Plugin.register_input('rds_mysql_slow_log', self)
+
+    config_param :database_timezone, :string, default: nil, desc: 'The timezone of the database.'
+    config_param :emit_interval, :time, default: 10, desc: 'The interval in seconds to emit records.'
+    config_param :encoding, :string, default: nil, desc: 'The encoding of strings in an emitted record.'
+    config_param :from_encoding, :string, default: nil, desc: 'The encoding of sql_text data.'
+    config_param :keep_time_key, :bool, default: false, desc: 'Keep the time key in an emitted record.'
+    config_param :null_empty_string, :bool, default: false, desc: 'Convert empty strings to null.'
+    config_param :tag_prefix, :string, default: nil, desc: 'The prefix of the tag.'
+    config_section :server, param_name: :servers, required: true do
+      config_param :host, :string, desc: 'The IP address or hostname of the server.'
+      config_param :password, :string, default: nil, secret: true, desc: 'The password to use when connecting to the server.'
+      config_param :port, :integer, default: 3306, desc: 'The port number of the server.'
+      config_param :tag, :string, desc: 'The tag of the event.'
+      config_param :username, :string, default: nil, desc: 'The username to use when connecting to the server.'
+    end
+
+    def configure(conf)
+      super
+
+      configure_servers
+      configure_timezone
+      configure_encoding
+    end
+
+    def configure_servers
+      @servers.map! do |s|
+        tag = @tag_prefix ? "#{@tag_prefix}.#{s.tag}" : s.tag
+        [tag, Server.new(s.host, s.port, s.username, s.password)]
+      end
+    end
+
+    def configure_timezone
+      @database_timezone = parse_timezone_param(@database_timezone) if @database_timezone
+    end
+
+    def parse_timezone_param(timezone)
+      TZInfo::Timezone.get(timezone)
+    rescue InvalidTimezoneIdentifier => e
+      raise ConfigError, e.message
+    end
+
+    def configure_encoding
+      if !@encoding && @from_encoding
+        raise ConfigError, "'from_encoding' parameter must be specified with 'encoding' parameter."
+      end
+
+      @encoding = parse_encoding_param(@encoding) if @encoding
+      @from_encoding = parse_encoding_param(@from_encoding) if @from_encoding
+    end
+
+    def parse_encoding_param(encoding)
+      Encoding.find(encoding)
+    rescue ArgumentError => e
+      raise ConfigError, e.message
+    end
+
+    def start
+      super
+
+      @loop = Coolio::Loop.new
+      @timer = TimerWatcher.new(@emit_interval, true, log, &method(:on_timer))
+      @loop.attach(@timer)
+      @thread = Thread.new(&method(:run))
+    end
+
+    def run
+      @loop.run
+    rescue
+      log.error $!.to_s
+      log.error_backtrace
+    end
+
+    def on_timer
+      @servers.each do |tag, server|
+        emit_slow_log(tag, server)
+      end
+    end
+
+    def emit_slow_log(tag, server)
+      server.connect do |client|
+        client.query('CALL mysql.rds_rotate_slow_log')
+
+        es = MultiEventStream.new
+        client.query('SELECT * FROM slow_log_backup').each do |row|
+          es.add(*process(row))
+        end
+
+        router.emit_stream(tag, es)
+      end
+    rescue
+      log.error $!.to_s
+      log.error_backtrace
+    end
+
+    def process(record)
+      process_timestamp(record)
+      process_string(record)
+      process_time(record)
+      process_integer(record)
+      [extract_time(record), record]
+    end
+
+    def process_timestamp(record)
+      record['start_time'] &&= timestamp_to_time(record['start_time'])
+    end
+
+    def timestamp_to_time(timestamp)
+      year, month, day, hour, min, sec, usec = timestamp.scanf('%4u-%2u-%2u %2u:%2u:%2u.%6u')
+      t = Time.utc(year, month, day, hour, min, sec, usec)
+      @database_timezone ? @database_timezone.local_to_utc(t) : t
+    end
+
+    def process_string(record)
+      if @null_empty_string
+        %w[user_host db sql_text].each do |field|
+          record[field] = nil if (record[field] || '').empty?
+        end
+      end
+
+      if @encoding
+        encode(record['user_host'], @encoding, Encoding::UTF_8)
+        encode(record['db'], @encoding, Encoding::UTF_8)
+        encode(record['sql_text'], @encoding, @from_encoding)
+      end
+    end
+
+    def encode(str, dst, src)
+      if str.nil?
+        nil
+      elsif src
+        str.encode!(dst, src)
+      else
+        str.force_encoding(dst)
+      end
+    end
+
+    def process_time(record)
+      %w[query_time lock_time].each do |field|
+        record[field] &&= time_to_microseconds(record[field])
+      end
+    end
+
+    def time_to_microseconds(time)
+      hour, min, sec, usec = time.scanf('%2u:%2u:%2u.%6u')
+      hour * 3_600_000_000 + min * 60_000_000 + sec * 1_000_000 + usec.to_i
+    end
+
+    def process_integer(record)
+      %w[
+        rows_sent
+        rows_examined
+        last_insert_id
+        insert_id
+        server_id
+        thread_id
+        rows_affected
+      ].each do |field|
+        record[field] &&= record[field].to_i
+      end
+    end
+
+    def extract_time(record)
+      time = @keep_time_key ? record['start_time'] : record.delete('start_time')
+      (time || Engine.now).to_i
+    end
+
+    def shutdown
+      super
+
+      @loop.watchers.each(&:detach)
+      @loop.stop
+      @thread.join
+    end
+
+    class Server
+      def initialize(host, port, username, password)
+        @host = host
+        @port = port
+        @username = username
+        @password = password
+      end
+
+      def connect
+        client = Mysql2::Client.new(
+          host: @host,
+          port: @port,
+          username: @username,
+          password: @password,
+          database: 'mysql',
+          cache_rows: false,
+          cast: false
+        )
+        yield client
+      ensure
+        client.close if client
+      end
+    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
+        @log.error $!.to_s
+        @log.error_backtrace
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-rds-mysql-slow-log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Satoshi Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.58
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.58
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: tzinfo
+  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: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Fluentd input plugin for MySQL slow query log table on Amazon RDS.
+email:
+- kaorimatz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-rds-mysql-slow-log.gemspec
+- lib/fluent/plugin/in_rds_mysql_slow_log.rb
+homepage: https://github.com/kaorimatz/fluent-plugin-rds-mysql-slow-log
+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.5
+signing_key: 
+specification_version: 4
+summary: Fluentd input plugin for MySQL slow query log table on Amazon RDS
+test_files: []