fluent-plugin-mysql-query 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2012- Kentaro Yoshida
+
+   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,57 @@
+fluent-plugin-mysql-query
+===========================
+
+Fluentd Input plugin to execute mysql command intervaled.
+
+## Installation
+
+### native gem
+
+`````
+gem install fluent-plugin-mysql-query
+`````
+
+### td-agent gem
+`````
+/usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mysql-query
+`````
+
+## Configuration
+
+### Config Sample
+`````
+<source>
+  type            mysql_query
+  server          localhost           # Optional (default: localhost)
+  port            3306                # Optional (default: 3306)
+  username        nagios              # Optional (default: root)
+  password        passw0rd            # Optional (default nopassword)
+  interval        30s                 # Optional (default: 1m)
+  tag             input.mysql         # Required
+  query           SHOW VARIABLES LIKE 'Thread_%' # Required
+  record_hostname yes                 # Optional (yes/no)
+</source>
+
+<match input.mysql>
+  type stdout
+</match>
+`````
+
+### Output Sample
+`````
+input.mysql: {"hostname":"myhost.example.com","Variable_name":"thread_cache_size","Value":"16"}
+input.mysql: {"hostname":"myhost.example.com","Variable_name":"thread_stack","Value":"262144"}
+`````
+
+## TODO
+patches welcome!
+* support results into array option
+* support result_key_downcase option
+
+## Copyright
+
+Copyright © 2012- Kentaro Yoshida (@yoshi_ken)
+
+## License
+
+Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,10 @@
+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-mysql-query.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-mysql-query"
+  s.version     = "0.0.1"
+  s.authors     = ["Kentaro Yoshida"]
+  s.email       = ["y.ken.studio@gmail.com"]
+  s.homepage    = "https://github.com/y-ken/fluent-plugin-mysql-query"
+  s.summary     = %q{Fluentd Input plugin to execute mysql query with custom intervals.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "fluentd"
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "mysql2"
+end

data/lib/fluent/plugin/in_mysql_query.rb

@@ -0,0 +1,78 @@
+module Fluent
+  class MysqlQueryInput < Fluent::Input
+    Plugin.register_input('mysql_query', self)
+
+    def initialize
+      require 'mysql2'
+      super
+    end
+
+    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, :string, :default => '1m'
+    config_param :record_hostname, :string, :default => nil
+    config_param :tag, :string
+    config_param :query, :string
+
+    def configure(conf)
+      super
+      @interval = Config.time_value(@interval)
+      @record_hostname = @record_hostname || false
+      @hostname = get_mysql_hostname
+      $log.info "adding mysql_query job: [#{@query}] interval: #{@interval}sec"
+    end
+
+    def start
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      Thread.kill(@thread)
+    end
+
+    def run
+      loop do 
+        con = query(@query)
+        con.each do |row|
+          tag = "#{@tag}".gsub('__HOSTNAME__', @hostname).gsub('${hostname}', @hostname)
+          record = Hash.new
+          record.store('hostname', @hostname) if @record_hostname
+          record.merge!(row)
+          Engine.emit(tag, Engine.now, record)
+        end
+        sleep @interval
+      end
+    end
+
+    def get_connection
+      return Mysql2::Client.new({
+        :host => @host, 
+        :port => @port,
+        :username => @username,
+        :password => @password,
+        :database => @database,
+        :encoding => @encoding,
+        :reconnect => true
+      })
+    end
+
+    def query(query)
+      @mysql ||= get_connection
+      begin
+        return @mysql.query(query)
+      rescue Exception => e
+        $log.info "#{e.inspect}"
+      end
+    end
+
+    def get_mysql_hostname
+      query("SHOW VARIABLES LIKE 'hostname'").each do |row|
+        return row.fetch('Value')
+      end
+    end
+  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/in_mysql_query'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_mysql_query.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class MysqlQueryInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    host            localhost
+    port            3306
+    interval        30
+    tag             input.mysql
+    query           SHOW VARIABLES LIKE 'Thread_%'
+    record_hostname yes
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::MysqlQueryInput, tag).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
+    ]
+    d.instance.inspect
+    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 'yes', d.instance.record_hostname
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mysql-query
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Yoshida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &8375040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *8375040
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &8373740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8373740
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &8372580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8372580
+description: 
+email:
+- y.ken.studio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-mysql-query.gemspec
+- lib/fluent/plugin/in_mysql_query.rb
+- test/helper.rb
+- test/plugin/test_in_mysql_query.rb
+homepage: https://github.com/y-ken/fluent-plugin-mysql-query
+licenses: []
+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.11
+signing_key: 
+specification_version: 3
+summary: Fluentd Input plugin to execute mysql query with custom intervals.
+test_files:
+- test/helper.rb
+- test/plugin/test_in_mysql_query.rb