fluent-plugin-vertica-query 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abc50c357a3a49197555d92cd9f4de03e4fa5b4a
+  data.tar.gz: 295737f289ead087497e5fb2c50c79f6695a008e
+SHA512:
+  metadata.gz: ca7dec83f73c36e5a0e21205295ba05d0b0a63465a27f82b6cf8455a10c65488efd19f398213037d68fd0b6eb07ad8f214d0284fe1258da835f8d802e11f87f6
+  data.tar.gz: 24dc3efbc6d94f4b5b1785d738e7dc2b17b7f35fe2424fc50d1afab513d03aee10bf8e0301e1127006063ffea9869fa9780ef52e86e1ecf514cf321a98add66d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.0.0
+  - 1.9.3

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,69 @@
+fluent-plugin-vertica-query
+===========================
+
+Fluentd Input plugin to execute vertica query and fetch rows. It is useful for stationary interval metrics measurement.
+
+## Installation
+
+install with gem or fluent-gem command as:
+
+```
+# for fluentd
+$ gem install fluent-plugin-vertica-query
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-vertica-query
+```
+
+## Configuration
+
+### Config Sample
+`````
+<source>
+  type            vertica_query
+  host            localhost           # Optional (default: localhost)
+  port            5433                # Optional (default: 5433)
+  username        nagios              # Optional (default: dbadmin)
+  password        passw0rd            # Optional (default not set)
+  interval        30s                 # Optional (default: 1m)
+  database        db                  # Optional (default: not set as there is only one database per cluster)
+  ssl             true                # Optional connection via ssl (default: false)
+  role            pseudosuperuser     # Optional additional role(s) to set for the user
+  search_path     test_date           # Optional (default: not set)
+  tag             input.vertica       # Required
+  query           SELECT * FROM V_CATALOG.RESOURCE_POOLS; # Required
+  # record hostname into message.
+  record_host     yes                 # Optional (default: no)
+  # multi row results into nested record or separated message.
+  nest_result     yes                 # Optional (default: no)
+  nest_key        data                # Optional (default: result)
+  # record the number of lines of a query result
+  row_count       yes                 # Optional (default: no)
+  row_count_key   row_count           # Optional (default: row_count)
+</source>
+
+<match input.vertica>
+  type stdout
+</match>
+`````
+
+### Output Sample
+record_hostname: yes, nest_result: no
+`````
+input.vertica: {"hostname":"myhost.example.com","Variable_name":"thread_cache_size","Value":"16"}
+input.vertica: {"hostname":"myhost.example.com","Variable_name":"thread_stack","Value":"262144"}
+`````
+record_hostname: yes, nest_result: yes, nest_key: data
+`````
+input.vertica: {"hostname":"myhost.example.com","data":[{"Variable_name":"thread_cache_size","Value":"16"},{"Variable_name":"thread_stack","Value":"262144"}]}
+`````
+record_hostname: yes, nest_result: yes, nest_key: data, row_count: yes, row_count_key: row_count
+`````
+input.vertica: {"hostname":"myhost.example.com","row_count":2,"data":[{"Variable_name":"thread_cache_size","Value":"16"},{"Variable_name":"thread_stack","Value":"262144"}]}
+`````
+
+### Example Query
+* SELECT MAX(id) AS max_foo_id FROM foo_table;
+* SELECT * FROM nodes;
+* SELECT * FROM V_CATALOG.RESOURCE_POOLS;
+* SELECT user_id, memory_cap_kb FROM users WHERE resource_pool='general';

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-vertica-query.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-vertica-query"
+  s.version     = "0.0.7"
+  s.authors     = ["John Dodson"]
+  s.email       = ["john.dodson@intentmedia.com"]
+  s.homepage    = "https://github.com/intentmedia/fluent-plugin-vertica-query"
+  s.summary     = %q{Fluentd Input plugin to execute Vertica query and fetch rows. It is useful for stationary interval metrics measurement. Forked from Kentaro Yoshida's fluent-plugin-mysql-query gem.}
+
+  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"
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "vertica"
+end

data/lib/fluent/plugin/in_vertica_query.rb

@@ -0,0 +1,100 @@
+module Fluent
+  class VerticaQueryInput < Fluent::Input
+    Plugin.register_input('vertica_query', self)
+
+    def initialize
+      require 'vertica'
+      require 'socket'
+      super
+    end
+
+    config_param :host, :string, :default => 'localhost'
+    config_param :port, :integer, :default => 5433
+    config_param :username, :string, :default => 'dbadmin'
+    config_param :password, :string, :default => nil
+    config_param :database, :string, :default => nil
+    config_param :ssl, :bool, :default => false # use SSL for the connection
+    config_param :role, :string, :default => nil   # the (additional) role(s) to enable for the user.
+    config_param :search_path, :string, :default => nil
+    config_param :encoding, :string, :default => 'utf8'
+    config_param :interval, :time, :default => '1m'
+    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_host, :bool, :default => false
+    config_param :tag, :string
+    config_param :query, :string
+
+    def configure(conf)
+      super
+      @hostname = nil
+      $log.info "adding vertica_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
+        tag = "#{@tag}".gsub('__HOSTNAME__', @host).gsub('${hostname}', @host)
+        record = Hash.new
+        record.store('host', @host) if @record_host
+        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
+        end
+        sleep @interval
+      end
+    end
+
+    def get_connection
+      begin
+        return Vertica.connect({
+          :host => @host,
+          :port => @port,
+          :username => @username,
+          :password => @password,
+          :database => @database,
+          :encoding => @encoding,
+          :reconnect => true
+        })
+      rescue Exception => e
+        $log.warn "vertica_query: #{e}"
+        sleep @interval
+        retry
+      end
+    end
+
+    def query(query)
+      @vertica ||= get_connection
+      begin
+        return @vertica.query(query)
+      rescue Exception => e
+        $log.warn "vertica_query: #{e}"
+        sleep @interval
+        retry
+      end
+    end
+
+    def get_exec_result
+      result = Array.new
+      stmt = query(@query)
+      stmt.each do |row|
+        result.push(row)
+      end
+      return result
+    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_vertica_query'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_vertica_query.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class VerticaQueryInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    host            localhost
+    port            5433
+    interval        30
+    tag             input.vertica
+    query           \echo test
+    record_host yes
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::VerticaQueryInput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    d = create_driver %[
+      host            localhost
+      port            5433
+      interval        30
+      tag             input.vertica
+      query           \echo test
+      record_host yes
+    ]
+    assert_equal 'localhost', d.instance.host
+    assert_equal 5433, d.instance.port
+    assert_equal 30, d.instance.interval
+    assert_equal 'input.vertica', d.instance.tag
+    assert_equal true, d.instance.record_host
+    assert_equal false, d.instance.nest_result
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-vertica-query
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- John Dodson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !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: 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: vertica
+  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'
+description: 
+email:
+- john.dodson@intentmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-vertica-query.gemspec
+- lib/fluent/plugin/in_vertica_query.rb
+- test/helper.rb
+- test/plugin/test_in_vertica_query.rb
+homepage: https://github.com/intentmedia/fluent-plugin-vertica-query
+licenses: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Fluentd Input plugin to execute Vertica query and fetch rows. It is useful
+  for stationary interval metrics measurement. Forked from Kentaro Yoshida's fluent-plugin-mysql-query
+  gem.
+test_files:
+- test/helper.rb
+- test/plugin/test_in_vertica_query.rb