fluent-plugin-mysql-query 0.3.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19011ab6e44bb3ce1711bcac6f1bf1052364ca1d
+  data.tar.gz: 5601aa756c94e9386cae4927d3e5fe2597ddb480
+SHA512:
+  metadata.gz: 2c44650fb0c06d5198566c2706d089f76ef76378560fcc52cc0287aca7be05ae2cb60e0c887ab85f405fea0ed807787a5b2a69413c214434b8cd0e8476334a35
+  data.tar.gz: cacaa5f3e27e44a7e08740167e4738baad00e5de945efdc9aca9a2e33de514e8f598afae7b2d2164541efffbc6541e530dbd7cdd89d2918c4e6b027c5f2f5f92

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
 rvm:
-  - 2.1
-  - 2.0.0
-  - 1.9.3
+  - 2.4.1
+  - 2.3.4
+  - 2.2.5
+  - 2.1.10

data/README.md

@@ -3,6 +3,13 @@ fluent-plugin-mysql-query [![Build Status](https://travis-ci.org/y-ken/fluent-pl
 
 Fluentd Input plugin to execute mysql query and fetch rows. It is useful for stationary interval metrics measurement.
 
+## Requirements
+
+| fluent-plugin-mysql | fluentd    | ruby   |
+|---------------------|------------|--------|
+| >= 0.4.0            | >= v0.14.0 | >= 2.1 |
+| < 0.4.0             | >= v0.12.0 | >= 1.9 |
+
 ## Installation
 
 install with gem or fluent-gem command as:
@@ -20,7 +27,7 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mysql-query
 ### Config Sample
 `````
 <source>
-  type            mysql_query
+  @type            mysql_query
   host            localhost           # Optional (default: localhost)
   port            3306                # Optional (default: 3306)
   username        nagios              # Optional (default: root)
@@ -39,7 +46,7 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mysql-query
 </source>
 
 <match input.mysql>
-  type stdout
+  @type stdout
 </match>
 `````
 

data/fluent-plugin-mysql-query.gemspec

@@ -1,9 +1,8 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-mysql-query"
-  s.version     = "0.3.0"
+  s.version     = "1.0.0"
   s.license     = "Apache-2.0"
   s.authors     = ["Kentaro Yoshida"]
   s.email       = ["y.ken.studio@gmail.com"]
@@ -16,6 +15,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake"
-  s.add_runtime_dependency "fluentd"
+  s.add_development_dependency "test-unit", ">= 3.1.0"
+  s.add_runtime_dependency "fluentd", "> 0.14.0", "< 2"
   s.add_runtime_dependency "mysql2"
 end

data/lib/fluent/plugin/in_mysql_query.rb

@@ -1,26 +1,26 @@
-module Fluent
-  class MysqlQueryInput < Fluent::Input
-    Plugin.register_input('mysql_query', self)
+require 'fluent/plugin/input'
+require 'mysql2'
 
-    def initialize
-      require 'mysql2'
-      super
-    end
+module Fluent::Plugin
+  class MysqlQueryInput < Fluent::Plugin::Input
+    Fluent::Plugin.register_input('mysql_query', self)
 
-    config_param :host, :string, :default => 'localhost'
-    config_param :port, :integer, :default => 3306
-    config_param :username, :string, :default => 'root'
-    config_param :password, :string, :default => nil
-    config_param :database, :string, :default => nil
-    config_param :encoding, :string, :default => 'utf8'
-    config_param :interval, :time, :default => '1m'
+    helpers :timer
+
+    config_param :host, :string, default: 'localhost'
+    config_param :port, :integer, default: 3306
+    config_param :username, :string, default: 'root'
+    config_param :password, :string, default: nil, secret: true
+    config_param :database, :string, default: nil
+    config_param :encoding, :string, default: 'utf8'
+    config_param :interval, :time, default: '1m'
     config_param :tag, :string
     config_param :query, :string
-    config_param :nest_result, :bool, :default => false
-    config_param :nest_key, :string, :default => 'result'
-    config_param :row_count, :bool, :default => false
-    config_param :row_count_key, :string, :default => 'row_count'
-    config_param :record_hostname, :bool, :default => false
+    config_param :nest_result, :bool, default: false
+    config_param :nest_key, :string, default: 'result'
+    config_param :row_count, :bool, default: false
+    config_param :row_count_key, :string, default: 'row_count'
+    config_param :record_hostname, :bool, default: false
 
     def configure(conf)
       super
@@ -29,46 +29,40 @@ module Fluent
     end
 
     def start
-      @thread = Thread.new(&method(:run))
-    end
-
-    def shutdown
-      Thread.kill(@thread)
+      super
+      timer_execute(:in_mysql_query, @interval, &method(:on_timer))
     end
 
-    def run
-      loop do
-        @hostname = get_mysql_hostname if @hostname.nil?
-        tag = "#{@tag}".gsub('__HOSTNAME__', @hostname).gsub('${hostname}', @hostname)
-        record = Hash.new
-        record.store('hostname', @hostname) if @record_hostname
-        result = get_exec_result
-        record.store(@row_count_key, result.size) if @row_count
-        if (@nest_result)
-          record.store(@nest_key, result)
-          Engine.emit(tag, Engine.now, record)
-        else
-          result.each do |data|
-            Engine.emit(tag, Engine.now, record.merge(data))
-          end
+    def on_timer
+      @hostname = get_mysql_hostname if @hostname.nil?
+      tag = "#{@tag}".gsub('__HOSTNAME__', @hostname).gsub('${hostname}', @hostname)
+      record = {}
+      record.store('hostname', @hostname) if @record_hostname
+      result = get_exec_result
+      record.store(@row_count_key, result.size) if @row_count
+      if (@nest_result)
+        record.store(@nest_key, result)
+        router.emit(tag, Fluent::Engine.now, record)
+      else
+        result.each do |data|
+          router.emit(tag, Fluent::Engine.now, record.merge(data))
         end
-        sleep @interval
       end
     end
 
     def get_connection
       begin
         return Mysql2::Client.new({
-          :host => @host,
-          :port => @port,
-          :username => @username,
-          :password => @password,
-          :database => @database,
-          :encoding => @encoding,
-          :reconnect => true
+          host: @host,
+          port: @port,
+          username: @username,
+          password: @password,
+          database: @database,
+          encoding: @encoding,
+          reconnect: true
         })
       rescue Exception => e
-        $log.warn "mysql_query: #{e}"
+        log.warn "mysql_query: #{e}"
         sleep @interval
         retry
       end
@@ -77,9 +71,9 @@ module Fluent
     def query(query)
       @mysql ||= get_connection
       begin
-        return @mysql.query(query, :cast => false, :cache_rows => false)
+        return @mysql.query(query, cast: false, cache_rows: false)
       rescue Exception => e
-        $log.warn "mysql_query: #{e}"
+        log.warn "mysql_query: #{e}"
         sleep @interval
         retry
       end
@@ -89,10 +83,12 @@ module Fluent
       query("SHOW VARIABLES LIKE 'hostname'").each do |row|
         return row.fetch('Value')
       end
+      # hostname variable is not present
+      return ''
     end
 
     def get_exec_result
-      result = Array.new
+      result = []
       stmt = query(@query)
       stmt.each do |row|
         result.push(row)

data/test/helper.rb

@@ -1,28 +1,14 @@
-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 'bundler/setup'
 require 'test/unit'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(__dir__)
 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/test/helpers'
+require 'fluent/test/driver/input'
 require 'fluent/plugin/in_mysql_query'
 
 class Test::Unit::TestCase
+  include Fluent::Test::Helpers
+  extend Fluent::Test::Helpers
 end

data/test/plugin/test_in_mysql_query.rb

@@ -14,27 +14,32 @@ class MysqlQueryInputTest < Test::Unit::TestCase
     record_hostname yes
   ]
 
-  def create_driver(conf=CONFIG,tag='test')
-    Fluent::Test::OutputTestDriver.new(Fluent::MysqlQueryInput, tag).configure(conf)
+  def create_driver(conf=CONFIG)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::MysqlQueryInput).configure(conf)
   end
 
-  def test_configure
-    assert_raise(Fluent::ConfigError) {
-      d = create_driver('')
-    }
-    d = create_driver %[
-      host            localhost
-      port            3306
-      interval        30
-      tag             input.mysql
-      query           SHOW VARIABLES LIKE 'Thread_%'
-      record_hostname yes
-    ]
-    assert_equal 'localhost', d.instance.host
-    assert_equal 3306, d.instance.port
-    assert_equal 30, d.instance.interval
-    assert_equal 'input.mysql', d.instance.tag
-    assert_equal true, d.instance.record_hostname
-    assert_equal false, d.instance.nest_result
+  sub_test_case "configure" do
+    test "empty" do
+      assert_raise(Fluent::ConfigError) do
+        create_driver('')
+      end
+    end
+
+    test "simple" do
+      d = create_driver %[
+        host            localhost
+        port            3306
+        interval        30
+        tag             input.mysql
+        query           SHOW VARIABLES LIKE 'Thread_%'
+        record_hostname yes
+      ]
+      assert_equal 'localhost', d.instance.host
+      assert_equal 3306, d.instance.port
+      assert_equal 30, d.instance.interval
+      assert_equal 'input.mysql', d.instance.tag
+      assert_equal true, d.instance.record_hostname
+      assert_equal false, d.instance.nest_result
+    end
   end
 end

metadata

@@ -1,62 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mysql-query
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Kentaro Yoshida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: mysql2
   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'
 description: 
@@ -66,8 +79,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -79,27 +92,26 @@ files:
 homepage: https://github.com/y-ken/fluent-plugin-mysql-query
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fluentd Input plugin to execute mysql query and fetch rows. It is useful
   for stationary interval metrics measurement.
 test_files: