fluent-plugin-sqlquery-ssh 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 783745761f7b0874235b8e93946c8f09845794ad
+  data.tar.gz: 736147289cd85f28d7e8eda154c229d2b2d244ab
+SHA512:
+  metadata.gz: 82b1ce653d51a8e33138fa5d0336b69366a749b5e9c8a730f35dbb5be57ff4ce01aab4d28f38a5e80b030957960415e78e189aa3f6cfae994c1ab7134a7041f2
+  data.tar.gz: e3ceb2f54ffab7efa67d100e8a1e533bbb83faf04b3d663b9d31adabbafc0faaec47c063c29e065381cb8f264092e3a1732db41f03c44ca1e33955016966bfff

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

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,43 @@
+
+===========================
+
+Fluentd Input plugin to execute mysql query and fetch rows across multiple dbs based on an initial shard query returning array of host/db to hit
+
+## Installation
+
+install with gem or fluent-gem command as:
+
+```
+# for fluentd
+$ fluentd-gem install fluent-plugin-sqlquery-ssh
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-sqlquery-ssh
+```
+
+## Configuration
+
+### Config Sample
+`````
+<source>
+  type sqlquery_ssh
+  shard_map_query SELECT database_host, group_concat(database_name) AS database_name FROM cust_customer WHERE status = 'customer' AND collect_stats=1 GROUP BY database_host order by database_host DESC;
+  query SELECT database() as customer from invoice
+  host system-reporting.db.prd.us-east-silo.ls  #only use for reporting slaves
+  ssh_gateway mgmt.us-east-silo.lightspeedapp.com
+  skip_shards [""] #currently broken. use shard query to reduce set.
+  ssh_username #user name with jumphost access
+  db_username #reporting db username (do not use this on prod other than reporting)
+  db_password #the db password for the user above.
+  nest_result no #whether to nest the result set
+  nest_key data #key to nest
+  row_count no #add row count to the return
+  row_count_key row_count
+  tag debug #the matching tag
+</source>
+
+<match debug*>
+  type stdout
+</match>
+`````
+

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-sqlquery-ssh.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-sqlquery-ssh"
+  s.version     = "0.1.10"
+  s.license     = "Apache-2.0"
+  s.authors     = "Niall Brown"
+  s.email       = "niall.brown@lightspeedretail.com"
+#  s.homepage    = "https://github.com/y-ken/fluent-plugin-mysql-query-ssh"
+  s.summary     = %q{Fluentd Input plugin to execute mysql query and fetch rows. It is useful for stationary interval metrics measurement.}
+
+  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"]
+
+  s.add_development_dependency "rake", ['~> 10.0', '>= 10.0.4']
+  s.add_development_dependency "test-unit", ['~> 3.1', '>= 3.1.0']
+  s.add_runtime_dependency "fluentd", [">= 0.10.30", "< 2"]
+  s.add_runtime_dependency "mysql2",  "~> 0.3.11"
+  s.add_runtime_dependency "net-ssh-gateway", ['~> 1.2', '>= 1.2.0']
+end

data/lib/fluent/plugin/in_sqlquery_ssh.rb

@@ -0,0 +1,259 @@
+require 'fluent/plugin/input'
+require 'fluent/config/error'
+
+module Fluent::Plugin
+  class SQLQueryInput < Input
+     Fluent::Plugin.register_input('sqlquery_ssh', self)
+
+    helpers :thread, :storage, :compat_parameters
+    unless method_defined?(:log)
+      define_method(:log) { $log }
+    end
+
+    def initialize
+      super
+      require 'mysql2'
+      require 'net/ssh/gateway'
+      require 'bigdecimal'
+    end
+
+   config_param :host, :string, :default => '127.0.0.1'
+   config_param :shard_db_name, :string, :default => 'customer'
+   config_param :skip_shards, :array, :default => nil
+   config_param :shard_map_query, :string, :default => nil
+   config_param :ssh_key, :integer, :default => 'id_rsa'
+   config_param :ssh_local_port, :integer, :default => 33009
+   config_param :ssh_gateway, :string, :default => nil
+   config_param :ssh_username, :string, :default => nil, :secret => true
+   config_param :ssh_passphrase, :string, :default => nil, :secret => true
+   config_param :db_username, :string, :default => 'root', :secret => true
+   config_param :db_password, :string, :default => 'atqM2rQZxp9GMY', :secret => true
+   #config_param :database, :string, :default => nil
+   #config_param :databases, :array, :default => nil #databases if passed in.
+   config_param :db_port, :integer, :default => 33006
+   config_param :encoding, :string, :default => 'utf8'
+   config_param :interval, :time, :default => '1d'
+   config_param :tag, :string
+   config_param :cast, :hash, :default => nil #cast a hash of key (column) to cast as (type)
+   config_param :query, :string
+   config_param :nest_result, :bool, :default => false
+   config_param :nest_key, :string, :default => 'data'
+   config_param :row_count, :bool, :default => true
+   config_param :row_count_key, :string, :default => 'row_count'
+   config_param :record_hostname, :bool, :default => true
+
+   config_param :connect_timeout, :integer, :default => '30'
+   config_param :read_timeout, :integer, :default => '600'
+   config_param :init_sql, :string, :default => nil
+
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      super
+      #thread_create(:, &method(:run))
+      @thread = Thread.new(&method(:run))
+      @ssh_port  = nil
+    end
+
+    def shutdown
+      @stop = "ending run"
+      @ssh_gate.close(@ssh_local_port)
+      @mysql = nil
+      if @thread
+        @thread.join
+        @thread = nil
+      end
+      super
+    end
+
+    def run
+      begin
+        $log.info "Begin run."
+        loop do
+          break if @stop
+           @shard_map ||= get_shards
+           #loop thru shards
+          begin
+             @shard_map.each do |shard|
+               break if @stop
+               shard.each do |remotehost,db_names|
+                  break if @stop
+                  @mysql = nil #close connection
+                  @ssh_gate.close(@ssh_local_port)
+                  hostname = remotehost.gsub(/mylocaldb([0-9]*)/, "customers\\1-reporting.db.prd.us-east-silo.ls")
+                  @host = hostname
+                  $log.info "start shard: #{hostname}\n"
+                  #handle the dbs
+                  process_shard_dbs(remotehost, db_names)
+                  $log.info "finished shard: #{hostname}\n"
+               end
+             end
+             @mysql = nil #close connection
+             @ssh_gate.close(@ssh_local_port)
+             #process_shards if @shard_map
+             $log.info "completed run all shards. sleeping for #{@interval}\n"
+            #end don't loop
+          rescue Exception => e
+            $log.error "error on shard: #{@current_shard}\n"
+            $log.error "#{e.message}\n#{e.backtrace.join("\n")}\n"
+          end
+          sleep @interval
+        end
+      rescue
+          # ignore
+      end
+    end
+    #get the shards.  put the info somewhere?
+    def get_shards
+      begin
+          @conn ||= get_connection
+          @conn.select_db(@shard_db_name) #switch the customerdb
+          $log.info "Getting Shard Mapping: [#{@shard_map_query}]"
+          @conn.query("SET SESSION group_concat_max_len=	1844674407370")
+          shard_mapping = Array.new
+          shardlist = @conn.query(@shard_map_query, :cast => false, :cache_rows => false)
+          shardlist.each do |row|
+            customer_dbs = row['database_name'].split(',')
+            cust_host = row['database_host']
+            shard = Hash.new(cust_host)
+            shard[cust_host] = customer_dbs
+            shard_mapping.push(shard)
+            $log.info "adding #{customer_dbs}\n"
+          end
+          @conn.close
+          return shard_mapping
+      rescue Exception => e
+        $log.error "Can't get shard info\n"
+        $log.error "#{e.message}\n#{e.backtrace.join("\n")}\n"
+        exit!
+      end
+    end
+
+    def process_shard_dbs(remotehost, db_names)
+        db_names.each do |db|
+         $log.info "customer: #{db} shard: #{remotehost}"
+         return if @stop
+         @mysql ||= get_connection #open conn to shard.
+         @current_shard = remotehost
+         @mysql.select_db(db) #switch the customerdb
+         #$log.info "check customer: #{db}\n"
+          tag = "#{@tag}_#{db}_#{remotehost}"
+          record = Hash.new
+            result = get_exec_result
+            #record.store(@row_count_key, result.size) if @row_count
+            result.each_with_index do |data, index|
+              router.emit(tag, Fluent::Engine.now, record.merge(data))
+            end
+            $log.info "completed #{db} rows: #{result.size}\n"
+        end
+    end
+
+    #get the query results
+    def get_exec_result
+      result = Array.new
+      stmt = query(@query)
+      stmt.each do |row|
+        #to be replaced by the cast array
+            row['avg'] = row['avg'].to_f.round(2) if row['avg']
+            row['daily_total'] = row['daily_total'].to_f if row['daily_total']
+            row['total_transactions'] = row['total_transactions'].to_i if row['total_transactions']
+            row['cust_of_customer'] = row['cust_of_customer'].to_i if row['cust_of_customer']
+            row['shop_count'] = row['shop_count'].to_i if row['shop_count']
+            row['items'] = row['items'].to_i if row['items']
+            row['register_count'] = row['register_count'].to_i if row['register_count']
+            row['customer_shard'] = @current_shard if  @current_shard
+        result.push(row)
+      end
+      return result
+    end
+
+    def query(query)
+      begin
+        return if @mysql.nil?
+        return @mysql.query(query, :cast => false, :cache_rows => false)
+      rescue Exception => e
+          $log.error "fluent-plugin-sqlquery-ssh: Query ERROR!\n"
+          $log.error "#{e.message}\n#{e.backtrace.join("\n")}\n"
+      end
+    end
+
+    # Returns +true+ if the column is either of type string or text.
+     def text?
+       type == :string || type == :text
+     end
+
+     # Returns +true+ if the column is either of type integer, float or decimal.
+     def number?
+       type == :integer || type == :float || type == :decimal
+     end
+
+    # convert something to a boolean
+     def value_to_boolean(value)
+       if value.is_a?(String) && value.empty?
+         nil
+       else
+         TRUE_VALUES.include?(value)
+       end
+     end
+
+    # Used to convert values to integer.
+     # handle the case when an integer column is used to store boolean values
+     def value_to_integer(value)
+       case value
+       when TrueClass, FalseClass
+         value ? 1 : 0
+       else
+         value.to_i rescue nil
+       end
+     end
+
+     # convert something to a BigDecimal
+     def value_to_decimal(value)
+       # Using .class is faster than .is_a? and
+       # subclasses of BigDecimal will be handled
+       # in the else clause
+       if value.class == BigDecimal
+         value
+       elsif value.respond_to?(:to_d)
+         value.to_d
+       else
+         value.to_s.to_d
+       end
+     end
+
+    def get_connection
+      begin
+        $log.info "Opening ssh tunnel to #{@ssh_gateway}\n"
+        @ssh_gate ||= Net::SSH::Gateway.new(@ssh_gateway, @ssh_username, :verbose => :debug ,:keys => [@ssh_key], :forward_agent => true)
+        @ssh_port = @ssh_gate.open(@host, 3306, @ssh_local_port) || @db_port
+        $log.info "connecting to #{@host}\n"
+        return  Mysql2::Client.new({
+          :host => '127.0.0.1',
+          :port => @ssh_port,
+          :username => @db_username,
+          :password => @db_password,
+          :encoding => @encoding,
+          :reconnect => true,
+          :read_timeout => 600,
+          :connect_timeout => 30
+        })
+      rescue Exception => e
+          $log.error "fluent-plugin-sqlquery-ssh: Main Connect ERROR!\n"
+          $log.error "MSG: #{e.message}\n TRACE:#{e.backtrace.join("\n")} PORT: #{@ssh_port}\n"
+          #sleep @interval
+          #retry
+      end
+      return nil
+    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_sqlquery_ssh.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class SQLQueryInputTest < 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
+    ]
+    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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sqlquery-ssh
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Niall Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - '>='
+      - !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'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !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'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.30
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.30
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: 
+email: niall.brown@lightspeedretail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-sqlquery-ssh.gemspec
+- lib/fluent/plugin/in_sqlquery_ssh.rb
+- test/helper.rb
+- test/plugin/test_in_sqlquery_ssh.rb
+homepage: 
+licenses:
+- Apache-2.0
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Fluentd Input plugin to execute mysql query and fetch rows. It is useful
+  for stationary interval metrics measurement.
+test_files:
+- test/helper.rb
+- test/plugin/test_in_sqlquery_ssh.rb