fluent-plugin-aurora-slowquerylog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9829f923bc32db96e938ead936dd483631510115
+  data.tar.gz: fa6d2a8526c68d94952eb0a30fe6ccd0238fb169
+SHA512:
+  metadata.gz: 341d4e4863651fb0b0b717e0d2df52d959f65fb485b6b7ae7a66922c664191e20333601392185b1ae1be234c3fa88770dfff9984a49fbc38732ebebcc93ea703
+  data.tar.gz: 2c45ea22e75312ab2a2de7a0ac96e75c5cd0c73c9ed75306d5b136f5ee0abcb89a5086614c059d817e478e634bf71c70fc4789ede188af65ec465385fe519d46

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Takayuki WATANABE
+
+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,41 @@
+# Fluent::Plugin::Aurora::Slowquerylog
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fluent/plugin/aurora/slowquerylog`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-aurora-slowquerylog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-aurora-slowquerylog
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 `version.rb`, 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/[USERNAME]/fluent-plugin-aurora-slowquerylog.
+
+
+## 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,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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/aurora/slowquerylog"
+
+# 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

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

@@ -0,0 +1,27 @@
+# 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-aurora-slowquerylog"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Takayuki WATANABE"]
+  spec.email         = ["takanabe.w@gmail.com"]
+
+  spec.summary       = "A fluentd plugin that collects AWS Aurora slow query logs with `log_output=FILE`"
+  spec.description   = "A fluentd plugin that collects AWS Aurora slow query logs with `log_output=FILE`"
+  spec.homepage      = "https://github.com/takanabe/fluent-plugin-aurora-slowquerylog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd"
+  spec.add_runtime_dependency "aws-sdk", '~> 2'
+  spec.add_runtime_dependency "myslog"
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "test-unit", ">= 3.0.0"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/fluent/plugin/in_aurora_slow_query_log.rb

@@ -0,0 +1,232 @@
+require 'active_support/all'
+require 'aws-sdk-core'
+require 'fluent/input'
+require "json"
+require 'myslog'
+require 'yaml'
+
+module Fluent
+  class AuroraSlowqueryLog < Input
+    # First, register the plugin. NAME is the name of this plugin
+    # and identifies the plugin in the configuration file.
+    Fluent::Plugin.register_input('NAME', self)
+
+    # config_param defines a parameter. You can refer a parameter via @port instance variable
+    # :default means this parameter is optional
+    config_param :tag, :string                    # tag.child_tag
+    config_param :db_instance_identifier, :string # rds-instance-id
+    config_param :region, :string                 # us-east-1
+    config_param :log_file_name, :string          # slowquery/mysql-slowquery.log
+    config_param :aurora_state_file, :string      #/tmp/marker_state
+
+    # Following configs are necessary if you don't use IAM instance profile
+    config_param :log_fetch_interval, :time, :default => 60
+    config_param :aws_access_key_id, :string, default: nil
+    config_param :aws_secret_access_key, :string, default: nil
+    config_param :filename_contains, :string, default: 'mysql-slowquery.log'
+
+    def initialize
+      super
+      @current_slowlog = nil
+      @previous_slowlog = nil
+    end
+
+    # This method is called before starting.
+    # 'conf' is a Hash that includes configuration parameters.
+    # If the configuration is invalid, raise Fluent::ConfigError.
+    def configure(conf)
+      super
+    end
+
+    # This method is called when starting.
+    # Open sockets or files and create a thread here.
+    def start
+      super
+      @stop_flag = false
+      $log.debug 'Start aurora log collection thread'
+      @thread = Thread.new(&method(:thread_main))
+    end
+
+    # This method is called when shutting down.
+    def shutdown
+      super
+      @stop_flag = true
+      $log.debug 'Waiting for thread to finish'
+      @thread.join
+    end
+
+    def thread_main
+      until @stop_flag
+        begin
+          fetch_aurora_slow_log
+        rescue => e
+          log.error 'unexpected error', :error => e.message, :error_class => e.class
+          log.error_backtrace e.backtrace
+        end
+        sleep @log_fetch_interval
+      end
+    end
+
+    def create_rds_client
+      @rds_client = if @aws_access_key_id && @aws_secret_access_key
+                      Aws::RDS::Client.new(
+                        region: @region,
+                        access_key_id: @aws_access_key_id,
+                        secret_access_key: @aws_secret_access_key
+                      )
+                    else # Use IAM Profile
+                      Aws::RDS::Client.new(region: @region)
+                    end
+    end
+
+    def fetch_aurora_slow_log
+      create_rds_client
+      fetch_recent_slowlogs
+      if File.exist?(@aurora_state_file)
+        state = load_state
+        if slowlog_rotated?(state)
+          if state["additional_data_pending"]
+            log_file_name = "#{@log_file_name}.#{Time.now.utc.strftime("%Y-%m-%d.%H")}"
+            fetch_and_emit_log(log_file_name, state["marker"],true)
+          else
+            log_file_name = "#{@log_file_name}.#{Time.now.utc.strftime("%Y-%m-%d.%H")}"
+            fetch_and_emit_log(@log_file_name, state["marker"],false)
+          end
+        else
+          fetch_and_emit_log(@log_file_name, state["marker"],true)
+        end
+      else
+        fetch_and_emit_log(@log_file_name, false, true)
+      end
+    end
+
+    def fetch_and_emit_log(log_file_name,marker,save)
+      if save
+        if marker
+          fetched_file = @rds_client.download_db_log_file_portion(
+            db_instance_identifier: @db_instance_identifier,
+            log_file_name: log_file_name,
+            marker: marker)
+          save_state(fetched_file)
+          records = parse_fetched_file(fetched_file)
+          emit_slowlogs(records)
+        else
+          fetched_file = @rds_client.download_db_log_file_portion(
+            db_instance_identifier: @db_instance_identifier,
+            log_file_name: "slowquery/mysql-slowquery.log")
+          save_state(fetched_file)
+          records = parse_fetched_file(fetched_file)
+          emit_slowlogs(records)
+        end
+      else # Executed when log rotation occurs without pending data
+        fetched_file = @rds_client.download_db_log_file_portion(
+          db_instance_identifier: @db_instance_identifier,
+          log_file_name: log_file_name,
+          marker: marker)
+        system("rm #{@aurora_state_file}")
+        records = parse_fetched_file(fetched_file)
+        emit_slowlogs(records)
+      end
+    end
+
+    def parse_fetched_file(fetched_file)
+      parsed_log_data= parse_query(fetched_file)
+      exclude_useless_sql(parsed_log_data)
+    end
+
+    def parse_query(fetched_file)
+      myslog = MySlog.new
+      myslog.parse(fetched_file.log_file_data)
+    end
+
+    def load_state
+      begin
+        YAML.load_file(@aurora_state_file)
+      rescue SystemCallError => e
+        puts %Q(class=[#{e.class}] message=[#{e.message}])
+      rescue IOError => e
+        puts %Q(class=[#{e.class}] message=[#{e.message}])
+      end
+    end
+
+    def slowlog_rotated?(state)
+      if @previous_slowlog == state["previous_slowlog"]
+        false
+      else
+        true
+      end
+    end
+
+    def fetch_recent_slowlogs
+      log_files = []
+      unix_time_2hours_ago = (2.hours.ago.to_f * 1000).floor
+
+      @rds_client.describe_db_log_files(db_instance_identifier: @db_instance_identifier, filename_contains: @filename_contains, file_last_written: unix_time_2hours_ago).each do |page|
+        page.describe_db_log_files.each do |f|
+          log_files << f
+        end
+      end
+
+      sorted_slow_log_files = log_files.sort_by do |f|
+        f.last_written
+      end
+
+      if sorted_slow_log_files.length >= 2
+        current,previous = sorted_slow_log_files[-1], sorted_slow_log_files[-2]
+        @current_slowlog = current.log_file_name
+        @previous_slowlog = previous.log_file_name
+      elsif sorted_slow_log_files.length >= 1
+        current = sorted_slow_log_files[-1]
+        @current_slowlog = current.log_file_name
+      else
+        raise "There is no slowlog. Please set log_output=FILE"
+      end
+    end
+
+    def save_state(fetched_file)
+      open(@aurora_state_file, 'w') do |f|
+        state_keys={}
+        state_keys["marker"] = fetched_file.marker
+        state_keys["additional_data_pending"] = fetched_file.additional_data_pending
+        state_keys["current_slowlog"] = @current_slowlog
+        state_keys["previous_slowlog"] = @previous_slowlog
+        YAML.dump(state_keys,f)
+      end
+    end
+
+    # Exclude useless SQL queries
+    def exclude_useless_sql(parsed_log_data)
+      responses = []
+      parsed_log_data.each do |record|
+        if m = record[:sql].match(/^\/rdsdbbin\/oscar\/bin\/mysqld/)
+          next
+        elsif m = record[:sql].match(/^(.+); \/rdsdbbin\/oscar\/bin\/mysqld,.+ Argument/)
+          responses << record
+          responses.last[:sql] = m[1]
+        elsif m = record[:sql].match(/^use .+; SET timestamp=\d+; (.+)/)
+          responses << record
+          responses.last[:sql] = m[1]
+        elsif m = record[:sql].match(/^SET timestamp=\d+; (.+)/)
+          responses << record
+          responses.last[:sql] = m[1]
+        else
+          responses << record
+        end
+      end
+      responses
+    end
+
+    def emit_slowlogs(records)
+      es = MultiEventStream.new
+      records.each do |record|
+        es.add(record[:date], record)
+      end
+      unless es.empty?
+        begin
+          router.emit_stream(@tag, es)
+        rescue
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-aurora-slowquerylog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takayuki WATANABE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-02 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: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: myslog
+  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: activesupport
+  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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: A fluentd plugin that collects AWS Aurora slow query logs with `log_output=FILE`
+email:
+- takanabe.w@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-aurora-slowquerylog.gemspec
+- lib/fluent/plugin/in_aurora_slow_query_log.rb
+homepage: https://github.com/takanabe/fluent-plugin-aurora-slowquerylog
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A fluentd plugin that collects AWS Aurora slow query logs with `log_output=FILE`
+test_files: []