fluent-plugin-sql_fingerprint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16f9a74d5b145d2aa1812144e2f5e08ca042d57c
+  data.tar.gz: 4f9c6215e10c779cde913f49fc78219868713f83
+SHA512:
+  metadata.gz: a4c8972f57f543c605da2647d425d28cdda42620281c4009c635e3c4fadbf680d430999dd51e8aa99737086a89f9b64c7d36f496e0af040df6e0e77120b0728f
+  data.tar.gz: a28ba79972e74b5ce66add8842683c99541e60ecb08578e0560f802e3359948d74a8cd8345b1b0061dd6f35dc2e26a1c1a59af8cf424dd12692ce94208bb6e39

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+.ruby-version
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.*
+  - 2.2.*
+gemfile:
+  - Gemfile

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Takahiro Kikumoto
+
+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,64 @@
+# fluent-plugin-sql_fingerprint
+
+[![Build Status](https://travis-ci.org/kikumoto/fluent-plugin-sql_fingerprint.svg?branch=master)](https://travis-ci.org/kikumoto/fluent-plugin-sql_fingerprint)
+
+A Fluent filter plugin to convert sql to sql's fingerprint.
+
+## Requirements
+
+Fluentd >= v0.12
+
+## Install
+
+```shell
+gem install fluent-plugin-sql_fingerprint
+```
+
+## Configuration Example
+
+```conf
+<filter tag.dummy.*>
+  type sql_fingerprint
+  fingerprint_tool_path /usr/bin/pt-fingerprint
+</filter>
+```
+
+### sample
+
+record before filter
+
+```
+{
+  "sql": "SELECT * FROM demo WHERE record = 'AAA';"
+}
+```
+
+record after filter
+
+```
+{
+  "sql": "SELECT * FROM demo WHERE record = 'AAA';",
+  "fingerprint": "select * from demo where record = ?"
+}
+```
+
+
+## Parameters
+
+* fingerprint_tool_path (required)
+
+  Tool path which generates fingerpint. 
+  It must input from standard input and output to standard output.
+  Ex. pt-fingerprint (see https://www.percona.com/doc/percona-toolkit/2.2/index.html)
+
+* target_key
+
+  The key which was passed to standard input of fingerprint_tool. Default is `sql`.
+
+* added_key
+
+  The key which was added to new record that holds fingerprint generated by fingerpinrt_tool. Default is `fingerprint`.
+
+## Copyright
+
+Copyright (c) 2015 Takahiro Kikumoto. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+desc 'Run test_unit based test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+  #t.warning = true
+end
+task :default => :test
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-sql_fingerprint.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+# $:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-sql_fingerprint"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Takahiro Kikumoto"]
+  spec.email         = ["kikumoto.takahiro@hamee.co.jp"]
+
+  spec.summary       = "A Fluent filter plugin to convert sql to sql's fingerprint"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/kikumoto/fluent-plugin-sql_fingerprint"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd", ">= 0.12"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/filter_sql_fingerprint.rb

@@ -0,0 +1,51 @@
+module Fluent
+  class SqlFingerprintFilter < Filter
+    Plugin.register_filter('sql_fingerprint', self)
+
+    def initialize
+      super
+      require "open3"
+    end
+
+    config_param :fingerprint_tool_path, :string
+    config_param :target_key, :string, :default => 'sql'
+    config_param :added_key, :string, :default => 'fingerprint'
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def filter(tag, time, record)
+      sql = hash_get(record, @target_key)
+      if !sql.nil? && !sql.empty?
+        record[@added_key] = fingerprint(sql)
+      end
+      record
+    end
+
+    def fingerprint(sql)
+      unless sql.empty?
+        o, s = Open3.capture2(@fingerprint_tool_path, :stdin_data => sql)
+        if s.success?
+          o.chomp!
+          sql = o unless o.empty? 
+        end
+      end
+      sql
+    end
+
+    def hash_get(hash, key)
+      return hash[key.to_sym] if hash.key?(key.to_sym)
+      return hash[key] if hash.key?(key)
+      nil
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end

data/test/test_sql_fingerprint.rb

@@ -0,0 +1,44 @@
+require_relative 'helper'
+require 'fluent/plugin/filter_sql_fingerprint'
+
+class SqlFingerprintFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(SqlFingerprintFilter).configure(conf, true)
+  end
+
+  def filter(d, msg)
+    d.run { d.filter(msg, @time) }
+    d.filtered
+  end
+
+  sub_test_case 'configure' do
+    def test_finggerprint_tool_path
+      assert_raise Fluent::ConfigError do
+        create_driver('')
+      end
+
+      d = create_driver(%[fingerprint_tool_path a_tool])
+      assert_equal "a_tool", d.instance.fingerprint_tool_path
+    end
+  end
+
+  sub_test_case 'filter' do
+    def test_sql_fingerprint
+      sql = "SELECT * FROM hogeho"
+      d = create_driver(%[fingerprint_tool_path cat])
+      msg = { 'sql' => sql }
+      es = filter(d, msg)
+      es.each do |t, r|
+        assert_equal(sql, r['sql'])
+        assert_equal(sql, r['fingerprint'])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sql_fingerprint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takahiro Kikumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: test-unit
+  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 Fluent filter plugin to convert sql to sql's fingerprint
+email:
+- kikumoto.takahiro@hamee.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-sql_fingerprint.gemspec
+- lib/fluent/plugin/filter_sql_fingerprint.rb
+- test/helper.rb
+- test/test_sql_fingerprint.rb
+homepage: https://github.com/kikumoto/fluent-plugin-sql_fingerprint
+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
+signing_key: 
+specification_version: 4
+summary: A Fluent filter plugin to convert sql to sql's fingerprint
+test_files:
+- test/helper.rb
+- test/test_sql_fingerprint.rb