fluent-plugin-query-fingerprint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3936fce40151f2e54a0340ef39950d8515a6a2962a57303db690229d28363166
+  data.tar.gz: 339033923ec216635b37f52adf3a728612b9c202ae47cba08b239000127a66c3
+SHA512:
+  metadata.gz: fd32ff03839e4d6d67c0d42f16119a3ed091c1b1264577280ee969f1747f9058a550214810b2226714c705ebbdd688b73240545ecd566e4624dc778c32149192
+  data.tar.gz: 50478fd018434817b124affa28d1e6160957f37dd2d6209970f5ac80783126fe215e759c263bb10e5d90469b374f9e9c2b6d71a9da7c97e82febe8aca78afd80

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Test
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+
+    strategy:
+      matrix:
+        ruby:
+        - 2.3.x
+        - 2.4.x
+        - 2.5.x
+        - 2.6.x
+
+    name: Ruby ${{ matrix.ruby }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install Bundler
+        run: gem install bundler -v '~>1.14'
+
+      - name: Bundle Install
+        run: bundle install --jobs 4 --retry 3 --path vendor/bundle
+
+      - name: Run Test
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,59 @@
+
+# Created by https://www.gitignore.io/api/ruby
+# Edit at https://www.gitignore.io/?templates=ruby
+
+### Ruby ###
+*.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
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## 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
+
+# End of https://www.gitignore.io/api/ruby

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,51 @@
+# fluent-plugin-query-fingerprint
+
+![](https://github.com/genkami/fluent-plugin-query-fingerprint/workflows/Test/badge.svg)
+
+[Fluentd](https://fluentd.org/) filter plugin to normalize SQL queires.
+
+This plugin does something like [pt-fingerprint](https://github.com/percona/percona-toolkit) to specific fields.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-query-fingerprint
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-query-fingerprint"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+* **query_key** (string)(required): The field name that contain queries to be fingerprinted.
+* **fingerprint_key** (string)(required): The field name to output fingerprint.
+* **preserve_embedded_numbers** (boolean)(optional): If it is set to true, the filter does not replace numbers in identifiers. Deafults to false.
+
+### Example Configuration
+
+```
+<filter pattern>
+  @type query_fingerprint
+  query_key sql
+  fingerprint_key fingerprint
+</filter>
+```
+
+## Copyright
+
+* Copyright(c) 2019- Genta Kamitani
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/bench/main.rb

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+
+require "benchmark"
+require "fluent/env"
+require "fluent/plugin/filter_query_fingerprint"
+
+module FingerprintBenchamrker
+  module_function
+
+  NUM_QUERIES = 10000
+
+  def benchmark
+    Benchmark.bmbm do |x|
+      x.report("simple select") do
+        b("SELECT * FROM `a_database`.`a_table` WHERE `a_column` = 'a_value'")
+      end
+      x.report("large insert") do
+        values = "(1, 'foo', true), " * 999 + "(1, 'foo', true)"
+        b("INSERT INTO `a_database`.`a_table` (`column1`, `column2`, `column3`) VALUES " + values)
+      end
+      x.report("large select") do
+        b %[
+          SELECT * FROM /* this is
+          a comment */ `a_database`.`a_table` AS `a` -- this is also a comment
+          JOIN `a_database`.`another_table` AS `b`
+          ON `a`.`id` = `b`.`a_id`
+          WHERE `a`.`a_column` = 12345
+          AND `b`.`another_column` LIKE 'foobar%'
+          ORDER BY `a`.`foo` ASC, `b`.`bar` DESC
+          LIMIT 10
+          OFFSET 100
+        ]
+      end
+    end
+  end
+
+  def b(query)
+    NUM_QUERIES.times do
+      Fluent::Plugin::QueryFingerprintFilter::Fingerprinter.fingerprint(query)
+    end
+  end
+end
+
+FingerprintBenchamrker.benchmark

data/fluent-plugin-query-fingerprint.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-query-fingerprint"
+  spec.version = "0.0.1"
+  spec.authors = ["Genta Kamitani"]
+  spec.email   = ["oftn.mofumofu@gmail.com"]
+
+  spec.summary       = %q{Fluentd plugin to normalize SQL queries}
+  spec.description   = %q{Fluentd plugin to normalize SQL queries}
+  spec.homepage      = "https://github.com/genkami/fluent-plugin-query-fingerprint"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/filter_query_fingerprint.rb

@@ -0,0 +1,86 @@
+#
+# Copyright 2019- Genta Kamitani
+#
+# 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.
+
+require "fluent/plugin/filter"
+
+module Fluent
+  module Plugin
+    class QueryFingerprintFilter < Fluent::Plugin::Filter
+      Fluent::Plugin.register_filter("query_fingerprint", self)
+
+      config_param :query_key, :string
+      config_param :fingerprint_key, :string
+      config_param :preserve_embedded_numbers, :bool, default: false
+
+      def filter(tag, time, record)
+        record[@fingerprint_key] = Fingerprinter.fingerprint(record[@query_key], preserve_embedded_numbers: @preserve_embedded_numbers)
+        record
+      end
+
+      module Fingerprinter
+        module_function
+
+        def fingerprint(query, preserve_embedded_numbers: false)
+          query = query.dup
+          return "mysqldump" if query =~ %r#\ASELECT /\*!40001 SQL_NO_CACHE \*/ \* FROM `#
+          return "percona-toolkit" if query =~ %r#\*\w+\.\w+:[0-9]/[0-9]\*/#
+          if match = /\A\s*(call\s+\S+)\(/i.match(query)
+            return match.captures.first.downcase!
+          end
+
+          if match = /\A((?:INSERT|REPLACE)(?: IGNORE)?\s+INTO.+?VALUES\s*\(.*?\))\s*,\s*\(/im.match(query)
+            query = match.captures.first
+          end
+
+          query.gsub!(%r#/\*[^!].*?\*/#m, "")
+          query.gsub!(/(?:--|#)[^\r\n]*(?=[\r\n]|\Z)/, "")
+
+          return query if query.gsub!(/\Ause \S+\Z/i, "use ?")
+
+          query.gsub!(/\\["']/, "")
+          query.gsub!(/".*?"/s, "?")
+          query.gsub!(/'.*?'/s, "?")
+
+          query.gsub!(/\btrue\b|\bfalse\b/i, "?")
+
+          if preserve_embedded_numbers
+            query.gsub!(/\b[0-9+-][0-9a-f.xb+-]*/, "?")
+          else
+            query.gsub!(/[0-9+-][0-9a-f.xb+-]*/, "?")
+          end
+          query.gsub!(/[xb.+-]\?/, "?")
+
+          query.strip!
+          query.gsub!(/[ \n\t\r\f]+/, " ")
+          query.downcase!
+
+          query.gsub!(/\bnull\b/i, "?")
+
+          query.gsub!(/\b(in|values?)(?:[\s,]*\([\s?,]*\))+/, "\\1(?+)")
+
+          query.gsub!(/\b(select\s.*?)(?:(\sunion(?:\sall)?)\s\1)+/, "\\1 /*repeat\\2*/")
+
+          query.gsub!(/\blimit \?(?:, ?\?| offset \?)/, "limit ?")
+
+          if query =~ /\border by/
+            query.gsub!(/\G(.+?)\s+asc/, "\\1")
+          end
+
+          query
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/filter"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_filter_query_fingerprint.rb

@@ -0,0 +1,412 @@
+require "helper"
+require "fluent/plugin/filter_query_fingerprint.rb"
+
+class QueryFingerprintFilterTest < Test::Unit::TestCase
+  FP = ::Fluent::Plugin::QueryFingerprintFilter::Fingerprinter
+
+  setup do
+    Fluent::Test.setup
+  end
+
+  sub_test_case "filter" do
+    test "query transformation" do
+      conf = %[
+        query_key query
+        fingerprint_key query_fingerprint
+      ]
+      d = create_driver(conf)
+      d.run(default_tag: "input.access") do
+        d.feed({"query" => "SELECT * FROM hoge WHERE fuga = 123"})
+        d.feed({"query" => "SELECT * FROM `hoge1`.`fuga2` WHERE `piyo3` = 123"})
+      end
+      filtered = d.filtered_records
+      assert_equal "select * from hoge where fuga = ?", filtered[0]["query_fingerprint"]
+      assert_equal "select * from `hoge?`.`fuga?` where `piyo?` = ?", filtered[1]["query_fingerprint"]
+    end
+
+    test "query transformation with perserve_embedded_numbers enabled" do
+      conf = %[
+        query_key query
+        fingerprint_key query_fingerprint
+        preserve_embedded_numbers true
+      ]
+      d = create_driver(conf)
+      d.run(default_tag: "input.access") do
+        d.feed({"query" => "SELECT * FROM hoge WHERE fuga = 123"})
+        d.feed({"query" => "SELECT * FROM `hoge1`.`fuga2` WHERE `piyo3` = 123"})
+      end
+      filtered = d.filtered_records
+      assert_equal "select * from hoge where fuga = ?", filtered[0]["query_fingerprint"]
+      assert_equal "select * from `hoge1`.`fuga2` where `piyo3` = ?", filtered[1]["query_fingerprint"]
+    end
+  end
+
+  sub_test_case "configure" do
+    test "missing query_key" do
+      conf = %[
+        fingerprint_key query_fingerprint
+      ]
+      assert_raise(Fluent::ConfigError) do
+        create_driver(conf)
+      end
+    end
+
+    test "missing fingerprint_key" do
+      conf = %[
+        query_key query
+      ]
+      assert_raise(Fluent::ConfigError) do
+        create_driver(conf)
+      end
+    end
+  end
+
+
+  sub_test_case "Fingerprinter.fingerprint" do
+    test "no side effect" do
+      q = "SELECT * FROM hoge WHERE fuga = 1"
+      FP.fingerprint(q)
+      assert_equal(q, "SELECT * FROM hoge WHERE fuga = 1")
+    end
+
+    test "mysqldump" do
+      assert_equal(
+        FP.fingerprint("SELECT /*!40001 SQL_NO_CACHE */ * FROM `the_table`"),
+        "mysqldump"
+      )
+    end
+
+    test "percona-toolkit" do
+      assert_equal(
+        FP.fingerprint("REPLACE /*foo.bar:3/3*/ INTO checksum.checksum"),
+        "percona-toolkit"
+      )
+    end
+
+    test "admin command" do
+      assert_equal(
+        FP.fingerprint("administrator command: Ping"),
+        "administrator command: ping"
+      )
+    end
+
+    test "`USE`" do
+      assert_equal(
+        FP.fingerprint("USE `the_table`"),
+        "use ?"
+      )
+    end
+
+    test "double-quoted strings" do
+      assert_equal(
+        FP.fingerprint(%{SELECT "foo_bar"}),
+        "select ?"
+      )
+    end
+
+    test "escaped double-quotes" do
+      assert_equal(
+        FP.fingerprint(%{SELECT "foo_\\"bar\\""}),
+        "select ?"
+      )
+    end
+
+    test "single-quoted strings" do
+      assert_equal(
+        FP.fingerprint(%{SELECT 'foo_bar'}),
+        "select ?"
+      )
+    end
+
+    test "escaped single quotes" do
+      assert_equal(
+        FP.fingerprint(%{SELECT 'foo_\\'bar\\''}),
+        "select ?"
+      )
+    end
+
+    test "TRUE" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = TRUE"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = true"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE true_column = true"),
+        "select * from a_table where true_column = ?"
+      )
+    end
+
+    test "FALSE" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = FALSE"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = false"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE false_column = false"),
+        "select * from a_table where false_column = ?"
+      )
+    end
+
+    test "numbers" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = 123"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = +123"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = -123"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = 0x12ab"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = 0b0011"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = 12.3"),
+        "select * from a_table where a_value = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value = .1"),
+        "select * from a_table where a_value = ?"
+      )
+    end
+
+    test "numbers in identifiers" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table0 WHERE a_value1 = 123"),
+        "select * from a_table? where a_value? = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table0 WHERE a_value1 = 123",
+                       preserve_embedded_numbers: true),
+        "select * from a_table0 where a_value1 = ?"
+      )
+    end
+
+    test "leading/trailing whitespaces" do
+      assert_equal(
+        FP.fingerprint("  \t\nSELECT * FROM a_table WHERE a_value = 123   \t\n"),
+        "select * from a_table where a_value = ?"
+      )
+    end
+
+    test "whitespaces" do
+      assert_equal(
+        FP.fingerprint("SELECT *\tFROM a_table  \n  \fWHERE\r\na_value = 123"),
+        "select * from a_table where a_value = ?"
+      )
+    end
+
+    test "NULLs" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value IS NULL"),
+        "select * from a_table where a_value is ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value IS null"),
+        "select * from a_table where a_value is ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE nullable IS null"),
+        "select * from a_table where nullable is ?"
+      )
+    end
+
+    test "`IN` operator" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value IN (1)"),
+        "select * from a_table where a_value in(?+)"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table WHERE a_value IN (1, 2, 3)"),
+        "select * from a_table where a_value in(?+)"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT SIN(3.14)"),
+        "select sin(?)"
+      )
+    end
+
+    test "`VALUES` function" do
+      assert_equal(
+        FP.fingerprint("INSERT INTO a_table (foo, bar) VALUES (1, 'aaa')"),
+        "insert into a_table (foo, bar) values(?+)"
+      )
+      assert_equal(
+        FP.fingerprint("INSERT INTO a_table (foo, bar) VALUES (1, 'aaa'), (2, 'bbb')"),
+        "insert into a_table (foo, bar) values(?+)"
+      )
+      assert_equal(
+        FP.fingerprint("INSERT INTO a_table (foo, bar) VALUE (1, 'aaa'), (2, 'bbb')"),
+        "insert into a_table (foo, bar) value(?+)"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT my_function_values(1, 2)"),
+        "select my_function_values(?, ?)"
+      )
+    end
+
+    test "UNIONing similar queries" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM foo WHERE bar = 1 "\
+                       "UNION SELECT * FROM foo WHERE bar = 2"),
+        "select * from foo where bar = ? /*repeat union*/"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM foo WHERE bar = 1 "\
+                       "UNION SELECT * FROM foo WHERE bar = 2 "\
+                       "UNION SELECT * FROM foo WHERE bar = 3"),
+        "select * from foo where bar = ? /*repeat union*/"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM foo WHERE bar = 1 "\
+                       "UNION ALL SELECT * FROM foo WHERE bar = 2"),
+        "select * from foo where bar = ? /*repeat union all*/"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM foo WHERE bar = 1 "\
+                       "UNION SELECT * FROM foo WHERE bar = 2 "\
+                       "UNION ALL SELECT * FROM foo WHERE bar = 3"),
+        "select * from foo where bar = ? /*repeat union all*/"
+      )
+
+      assert_equal(
+        FP.fingerprint("SELECT * FROM hoge INNER JOIN "\
+                       "(SELECT * FROM foo WHERE bar = 1 "\
+                       "UNION SELECT * FROM foo WHERE bar = 2) "\
+                       "ON hoge.id = foo.hoge_id"),
+        "select * from hoge inner join "\
+        "(select * from foo where bar = ? /*repeat union*/) "\
+        "on hoge.id = foo.hoge_id"
+      )
+
+      assert_equal(
+        FP.fingerprint("SELECT MY_FUNC_SELECT (1) "\
+                       "UNION SELECT (1)"),
+        "select my_func_select (?) union select (?)"
+      )
+    end
+
+    test "LIMIT clauses" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table LIMIT 10"),
+        "select * from a_table limit ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table LIMIT 5, 10"),
+        "select * from a_table limit ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table LIMIT 5,10"),
+        "select * from a_table limit ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM a_table LIMIT 10 OFFSET 5"),
+        "select * from a_table limit ?"
+      )
+    end
+
+    test "`ORDER BY` clauses" do
+      assert_equal(
+        FP.fingerprint("SELECT * from a_table ORDER BY foo"),
+        "select * from a_table order by foo"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * from a_table ORDER BY foo ASC"),
+        "select * from a_table order by foo"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * from a_table ORDER BY foo DESC"),
+        "select * from a_table order by foo desc"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * from a_table ORDER BY foo ASC, bar ASC"),
+        "select * from a_table order by foo, bar"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * from a_table ORDER BY foo ASC, bar DESC, baz ASC"),
+        "select * from a_table order by foo, bar desc, baz"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * from a_table ORDER BY foo ASC, bar DESC, baz, quux ASC"),
+        "select * from a_table order by foo, bar desc, baz, quux"
+      )
+    end
+
+    test "`CALL` procedures" do
+      assert_equal(
+        FP.fingerprint("CALL func(@foo, @bar)"),
+        "call func"
+      )
+      assert_equal(
+        FP.fingerprint("  CALL func(@foo, @bar)"),
+        "call func"
+      )
+    end
+
+    test "multi-line comments" do
+      assert_equal(
+        FP.fingerprint("SELECT hoge /* comment */ FROM fuga"),
+        "select hoge from fuga"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT hoge /* this is \n"\
+                       "a multi-line comment */ FROM fuga"),
+        "select hoge from fuga"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT hoge /* comment */ FROM /* another comment */ fuga"),
+        "select hoge from fuga"
+      )
+    end
+
+    test "multi-line comments followed by exclamation marks" do
+      assert_equal(
+        FP.fingerprint("SELECT /*! STRAIGHT_JOIN */ hoge from fuga, foo"),
+        "select /*! straight_join */ hoge from fuga, foo"
+      )
+    end
+
+    test "one-line comments" do
+      assert_equal(
+        FP.fingerprint("SELECT * FROM hoge -- comment"),
+        "select * from hoge"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM hoge -- comment\n"\
+                       "WHERE fuga = 1"),
+        "select * from hoge where fuga = ?"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM hoge # comment"),
+        "select * from hoge"
+      )
+      assert_equal(
+        FP.fingerprint("SELECT * FROM hoge # comment\n"\
+                       "WHERE fuga = 1"),
+        "select * from hoge where fuga = ?"
+      )
+    end
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::QueryFingerprintFilter).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-query-fingerprint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Genta Kamitani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Fluentd plugin to normalize SQL queries
+email:
+- oftn.mofumofu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bench/main.rb
+- fluent-plugin-query-fingerprint.gemspec
+- lib/fluent/plugin/filter_query_fingerprint.rb
+- test/helper.rb
+- test/plugin/test_filter_query_fingerprint.rb
+homepage: https://github.com/genkami/fluent-plugin-query-fingerprint
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to normalize SQL queries
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_query_fingerprint.rb