fluent-plugin-mysql-fetch-and-emit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a703eef6955132e07052f56cfbab2e60c8d8cca4c751412208e21204f292ac7a
+  data.tar.gz: 6ddc5374fcbaf7f0e633f406c5e50d099e5fb43f405a5f6ae2fc0f420f7a089e
+SHA512:
+  metadata.gz: 406424be8b299c036ebe6e814943fea5dee118154f2a27a45f3e61d2f996b26fe5c4d7de8d811c4c1a2829a83bc0a8ff48a809d3510dd96db8d3679933ab2075
+  data.tar.gz: 419361782102a6efb70f7cd0e1dcf03ae60a0506ea1b5f4dc4166acc612f6905a4f69a8f828ca02419aacc03d74802b3c0ea8ff07e00a1482e493c48bf48c269

data/.circleci/config.yml

@@ -0,0 +1,58 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.5.0
+       - image: circleci/mysql:5.7
+         environment:
+            MYSQL_ALLOW_EMPTY_PASSWORD: yes
+            MYSQL_DATABASE: sample
+            MYSQL_HOST: "127.0.0.1"
+            MYSQL_ROOT_HOST: "%"
+            MYSQL_USER: root
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: install dockerize
+          command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+          environment:
+            DOCKERIZE_VERSION: v0.3.0
+
+      - run:
+          name: Wait for db
+          command: dockerize -wait tcp://localhost:3306 -timeout 1m
+
+      # Database setup
+      - run: bundle exec rake circleci:db:create
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake test

data/.gitignore

@@ -0,0 +1 @@
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-mysql-fetch-and-emit (0.1.0)
+      fluentd (>= 0.14.10, < 2)
+      mysql2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cool.io (1.5.3)
+    dig_rb (1.0.1)
+    fluentd (1.1.3)
+      cool.io (>= 1.4.5, < 2.0.0)
+      dig_rb (~> 1.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 0.7.0, < 2.0.0)
+      serverengine (>= 2.0.4, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (~> 1.0)
+      tzinfo-data (~> 1.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.6.0)
+    msgpack (1.2.4)
+    mysql2 (0.5.0)
+    power_assert (1.1.1)
+    rake (12.3.1)
+    serverengine (2.0.6)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.3)
+    test-unit (3.2.7)
+      power_assert
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2018.4)
+      tzinfo (>= 1.0.0)
+    yajl-ruby (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  fluent-plugin-mysql-fetch-and-emit!
+  rake (~> 12.0)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

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,212 @@
+# fluent-plugin-mysql-fetch-and-emit
+[![CircleCI](https://circleci.com/gh/joker1007/fluent-plugin-mysql-fetch-and-emit.svg?style=svg)](https://circleci.com/gh/joker1007/fluent-plugin-mysql-fetch-and-emit)
+
+[Fluentd](https://fluentd.org/) output plugin to fetch from mysql by fluentd record and re-emit fetched record.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-mysql-fetch-and-emit
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-mysql-fetch-and-emit"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Example
+
+```
+<match tag>
+  @type mysql_fetch_and_emit
+
+  host 127.0.0.1
+  username root
+  password password
+  database db
+  table users
+
+  record_key id
+
+  tag new_tag
+</match>
+
+<match new_tag>
+  @type stdout
+</match>
+```
+
+## Record Matching
+
+```
+<match tag>
+  @type mysql_fetch_and_emit
+
+  host 127.0.0.1
+  username root
+  password password
+  database db
+  table users
+
+  record_key id
+
+  tag new_tag
+
+  <record_matching_key>
+    fluentd_record_key email
+    mysql_record_key email
+  </record_matching_key>
+</match>
+
+<match new_tag>
+  @type stdout
+</match>
+```
+
+If fluentd record has email and match email value of mysql record,
+plugin merges them.
+You can set priority of merged records by `merge_priority`.
+
+If `remove_keys` has some values,
+plugin remove key from fluentd record before merging.
+
+## Plugin helpers
+
+* [event_emitter](https://docs.fluentd.org/v1.0/articles/api-plugin-helper-event_emitter)
+* [record_accessor](https://docs.fluentd.org/v1.0/articles/api-plugin-helper-record_accessor)
+
+* See also: [Output Plugin Overview](https://docs.fluentd.org/v1.0/articles/output-plugin-overview)
+
+## Configuration
+
+### host (string) (optional)
+
+Database host.
+
+Default value: `127.0.0.1`.
+
+### port (integer) (optional)
+
+Database port.
+
+Default value: `3306`.
+
+### database (string) (required)
+
+Database name.
+
+### username (string) (required)
+
+Database user.
+
+### password (string) (optional)
+
+Database password.
+
+Default value: ``.
+
+### sslkey (string) (optional)
+
+SSL key.
+
+### sslcert (string) (optional)
+
+SSL cert.
+
+### sslca (string) (optional)
+
+SSL CA.
+
+### sslcapath (string) (optional)
+
+SSL CA path.
+
+### sslcipher (string) (optional)
+
+SSL cipher.
+
+### sslverify (bool) (optional)
+
+SSL Verify Server Certificate.
+
+### cast_booleans (bool) (optional)
+
+Tell Mysql2 to cast tinyint(1) fields to boolean values.
+
+### stream (bool) (optional)
+
+Fetch rows from the mysql on demand.
+
+### table (string) (required)
+
+Database table name.
+
+### tag (string) (required)
+
+New tag.
+
+### record_key (string) (required)
+
+Use the record value for where condition. (record_accessor format)
+
+### additional_condition (string) (optional)
+
+Append this value to where clause.
+
+### where_column (string) (optional)
+
+Database column name for where condition.
+
+### column_names (array) (optional)
+
+Select column names.
+
+Default value: `["*"]`.
+
+### \<record_matching_key\> section (optional) (multiple)
+
+#### fluentd_record_key (string) (required)
+
+Fluentd record key to identify target to merge with mysql record
+
+#### mysql_record_key (string) (required)
+
+Mysql record column name to identify target to merge with fluentd record
+
+### merge_priority (enum) (optional)
+
+Preserve data priority. If this is set :mysql, prioritize database record data.
+
+Available values: fluentd, mysql
+
+Default value: `fluentd`.
+
+### remove_keys (array) (optional)
+
+A list of keys to delete from fluentd record
+
+Default value: `[]`.
+
+### \<buffer\> section (optional) (multiple)
+
+#### chunk_limit_records () (optional)
+
+Default value: `1000`.
+
+
+## Copyright
+
+* Copyright(c) 2018- joker1007
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,24 @@
+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]
+
+namespace :circleci do
+  namespace :db do
+    task :create do
+      require "mysql2"
+
+      client = Mysql2::Client.new(host: "127.0.0.1", username: "root", password: "", database: "sample")
+      client.query("CREATE TABLE users (id INT unsigned NOT NULL AUTO_INCREMENT, name VARCHAR(191) NOT NULL, PRIMARY KEY (id))")
+    end
+  end
+end

data/fluent-plugin-mysql-fetch-and-emit.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-mysql-fetch-and-emit"
+  spec.version = "0.1.0"
+  spec.authors = ["joker1007"]
+  spec.email   = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Fluentd plugin to fetch record by input data, and to emit the record data.}
+  spec.description   = %q{Fluentd plugin to fetch record by input data, and to emit the record data.}
+  spec.homepage      = "https://github.com/joker1007/fluent-plugin-mysql-fetch-and-emit"
+  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"]
+  spec.add_runtime_dependency "mysql2"
+end

data/lib/fluent/plugin/out_mysql_fetch_and_emit.rb

@@ -0,0 +1,206 @@
+#
+# Copyright 2018- joker1007
+#
+# 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/output"
+require "mysql2"
+
+module Fluent
+  module Plugin
+    class MysqlFetchAndEmitOutput < Fluent::Plugin::Output
+      Fluent::Plugin.register_output("mysql_fetch_and_emit", self)
+
+      helpers :event_emitter, :record_accessor
+
+      config_param :host, :string, default: '127.0.0.1',
+        desc: "Database host."
+      config_param :port, :integer, default: 3306,
+        desc: "Database port."
+      config_param :database, :string,
+        desc: "Database name."
+      config_param :username, :string,
+        desc: "Database user."
+      config_param :password, :string, default: '', secret: true,
+        desc: "Database password."
+      config_param :sslkey, :string, default: nil,
+        desc: "SSL key."
+      config_param :sslcert, :string, default: nil,
+        desc: "SSL cert."
+      config_param :sslca, :string, default: nil,
+        desc: "SSL CA."
+      config_param :sslcapath, :string, default: nil,
+        desc: "SSL CA path."
+      config_param :sslcipher, :string, default: nil,
+        desc: "SSL cipher."
+      config_param :sslverify, :bool, default: nil,
+        desc: "SSL Verify Server Certificate."
+      config_param :cast_booleans, :bool, default: false,
+        desc: "Tell Mysql2 to cast tinyint(1) fields to boolean values."
+      config_param :stream, :bool, default: false,
+        desc: "Fetch rows from the mysql on demand."
+
+      config_param :table, :string,
+        desc: "Database table name."
+
+      config_param :tag, :string,
+        desc: "New tag."
+
+      config_param :record_key, :string,
+        desc: "Use the record value for where condition. (record_accessor format)"
+      config_param :where_column, :string, default: nil,
+        desc: "Database column name for where condition."
+      config_param :additional_condition, :string, default: nil,
+        desc: "Append this value to where clause."
+      config_param :column_names, :array, value_type: :string, default: ["*"],
+        desc: "Select column names."
+
+      config_section :record_matching_key, param_name: :record_matching_keys, required: false, multi: true do
+        config_param :fluentd_record_key, :string,
+          desc: "Fluentd record key to identify target to merge with mysql record"
+        config_param :mysql_record_key, :string,
+          desc: "Mysql record column name to identify target to merge with fluentd record"
+      end
+
+      config_param :merge_priority, :enum, list: [:fluentd, :mysql], default: :fluentd,
+        desc: "Preserve data priority. If this is set :mysql, prioritize database record data."
+      config_param :remove_keys, :array, value_type: :string, default: [],
+        desc: "A list of keys to delete from fluentd record"
+
+      config_section :buffer do
+        config_set_default :chunk_limit_records, 1000
+      end
+
+      def configure(conf)
+        super
+        @accessor_for_record_key = record_accessor_create(@record_key)
+        @accessors_for_record_matching = @record_matching_keys.map { |cf| record_accessor_create(cf.fluentd_record_key) }
+        @column_names_for_record_matching = @record_matching_keys.map { |cf| cf.mysql_record_key }
+      end
+
+      def format(tag, time, record)
+        value = @accessor_for_record_key.call(record)
+        unless @accessors_for_record_matching.empty?
+          keys_for_origin_record = @accessors_for_record_matching.map { |accessor| accessor.call(record) }
+          if keys_for_origin_record.any?(&:nil?)
+            @log.warn("Incoming record is omitted, because values for record matching include nil", record: record)
+            return nil
+          end
+        end
+
+        case value
+        when String, Integer, Float
+          [tag, time, record].to_msgpack
+        else
+          @log.warn("Incoming record is omitted, Supported value type of `record_key` is String, Integer, Float", record: record)
+          nil
+        end
+      end
+
+      def formatted_to_msgpack_binary?
+        true
+      end
+
+      def multi_workers_ready?
+        true
+      end
+
+      def where_column_name
+        @where_column || @record_key
+      end
+
+      def write(chunk)
+        database, table = expand_placeholders(chunk.metadata)
+        @handler = client(database)
+        where_values = []
+        origin_records = {}
+        chunk.msgpack_each do |tag, time, data|
+          value = @accessor_for_record_key.call(data)
+          case value
+          when String
+            where_values << "'" + Mysql2::Client.escape(value) + "'" if value
+          when Integer, Float
+            where_values << value.to_s if value
+          else
+            next
+          end
+
+          unless @accessors_for_record_matching.empty?
+            keys_for_origin_record = @accessors_for_record_matching.map { |accessor| accessor.call(data) }
+            parent = keys_for_origin_record[0..-2].inject(origin_records) do |h, v|
+              h[v] ||= {}
+            end
+            parent[keys_for_origin_record.last] = data
+          end
+        end
+        where_condition = "WHERE #{where_column_name} IN (#{where_values.join(',')})"
+
+        if @additional_condition
+          condition_sql = extract_placeholders(@additional_condition, chunk.metadata)
+          where_condition += " AND #{condition_sql}"
+        end
+
+        sql = "SELECT #{@column_names.join(", ")} FROM #{table} #{where_condition}"
+        @log.debug(sql)
+        results = @handler.query(sql, cast_booleans: @cast_booleans, stream: @stream)
+
+        time = Fluent::EventTime.now
+        results.each do |row|
+          unless @column_names_for_record_matching.empty?
+            record = @column_names_for_record_matching.inject(origin_records) do |h, k|
+              if h
+                h[row[k]]
+              end
+            end
+
+            if record
+              @remove_keys.each do |k|
+                record.delete(k)
+              end
+
+              if @merge_priority == :mysql
+                row = record.merge!(row)
+              else
+                row = row.merge!(record)
+              end
+            end
+          end
+          @log.debug("emit", tag: @tag, record: row)
+          router.emit(@tag, time, row)
+        end
+      end
+
+      def client(database)
+        Mysql2::Client.new(
+          host: @host,
+          port: @port,
+          username: @username,
+          password: @password,
+          database: database,
+          sslkey: @sslkey,
+          sslcert: @sslcert,
+          sslca: @sslca,
+          sslcapath: @sslcapath,
+          sslcipher: @sslcipher,
+          sslverify: @sslverify
+        )
+      end
+
+      def expand_placeholders(metadata)
+        database = extract_placeholders(@database, metadata).gsub('.', '_')
+        table = extract_placeholders(@table, metadata).gsub('.', '_')
+        return database, table
+      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/output"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_out_mysql_fetch_and_emit.rb

@@ -0,0 +1,226 @@
+require "helper"
+require "fluent/plugin/out_mysql_fetch_and_emit.rb"
+
+class MysqlFetchAndEmitOutputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+
+    mysql_client.query("INSERT INTO users (id, name) VALUES (1, 'user1'), (2, 'user2'), (3, 'user3')")
+  end
+
+  teardown do
+    mysql_client.query("TRUNCATE TABLE users")
+  end
+
+  test "mysql_connect" do
+    results = mysql_client.query("SELECT * FROM users ORDER BY id")
+    assert do
+      results.to_a.map { |row| row["id"] } == [1, 2, 3]
+    end
+  end
+
+  CONFIG = <<~CONF
+    host 127.0.0.1
+    username root
+    password ""
+    database sample
+    table users
+
+    record_key id
+    column_names ["id as foo", "name"]
+
+    tag new_tag
+  CONF
+
+  test "configure" do
+    driver = create_driver
+
+    assert_equal("id", driver.instance.where_column_name)
+  end
+
+  sub_test_case "write" do
+    test "single feed" do
+      driver = create_driver
+
+      driver.run do
+        driver.feed("tag", Time.now.to_i, {"id" => "1"})
+      end
+      event = driver.events[0]
+      assert_equal("new_tag", event[0])
+      assert_kind_of(Fluent::EventTime, event[1])
+      assert_equal({"foo" => 1, "name" => "user1"}, event[2])
+    end
+
+    test "multiple feed" do
+      driver = create_driver
+
+      driver.run do
+        driver.feed("tag", Time.now.to_i, {"id" => 1})
+        driver.feed("tag", Time.now.to_i, {"id" => 3})
+      end
+      event1 = driver.events[0]
+      event2 = driver.events[1]
+
+      assert_equal("new_tag", event1[0])
+      assert_kind_of(Fluent::EventTime, event1[1])
+      assert_equal({"foo" => 1, "name" => "user1"}, event1[2])
+
+      assert_equal("new_tag", event2[0])
+      assert_kind_of(Fluent::EventTime, event2[1])
+      assert_equal({"foo" => 3, "name" => "user3"}, event2[2])
+    end
+
+    test "multiple feed with additional_condition" do
+      driver = create_driver(CONFIG + "\n" + <<~CONF)
+        <buffer tag>
+        </buffer>
+        additional_condition "name = '${tag}'"
+      CONF
+
+      driver.run do
+        driver.feed("user1", Time.now.to_i, {"id" => 1})
+        driver.feed("user1", Time.now.to_i, {"id" => 3})
+      end
+      assert_equal(1, driver.events.size)
+      event1 = driver.events[0]
+
+      assert_equal("new_tag", event1[0])
+      assert_kind_of(Fluent::EventTime, event1[1])
+      assert_equal({"foo" => 1, "name" => "user1"}, event1[2])
+    end
+  end
+
+  sub_test_case "record_matching_key" do
+    test "mysql_record.merge(fluentd_record)" do
+      mysql_client.query("INSERT INTO users (id, name) VALUES (4, 'user1')")
+      driver = create_driver(CONFIG + "\n" + <<~CONF)
+        <buffer tag>
+        </buffer>
+
+        <record_matching_key>
+          fluentd_record_key id
+          mysql_record_key foo
+        </record_matching_key>
+      CONF
+
+      driver.run do
+        driver.feed("user1", Time.now.to_i, {"id" => 1, "name" => "new_user1", "hoge" => "bar1"})
+        driver.feed("user1", Time.now.to_i, {"id" => 3, "hoge" => "bar3"})
+        driver.feed("user1", Time.now.to_i, {"id" => 4, "name" => "new_user4", "hoge" => "bar4"})
+      end
+      assert_equal(3, driver.events.size)
+      event1 = driver.events[0]
+      event2 = driver.events[1]
+      event3 = driver.events[2]
+
+      assert_equal("new_tag", event1[0])
+      assert_kind_of(Fluent::EventTime, event1[1])
+      assert_equal({"id" => 1, "foo" => 1, "name" => "new_user1", "hoge" => "bar1"}, event1[2])
+      assert_equal({"id" => 3, "foo" => 3, "name" => "user3", "hoge" => "bar3"}, event2[2])
+      assert_equal({"id" => 4, "foo" => 4, "name" => "new_user4", "hoge" => "bar4"}, event3[2])
+    end
+
+    test "mysql_record.merge(fluentd_record) with remove_keys" do
+      mysql_client.query("INSERT INTO users (id, name) VALUES (4, 'user1')")
+      driver = create_driver(CONFIG + "\n" + <<~CONF)
+        <buffer tag>
+        </buffer>
+
+        <record_matching_key>
+          fluentd_record_key id
+          mysql_record_key foo
+        </record_matching_key>
+
+        remove_keys name, hoge
+      CONF
+
+      driver.run do
+        driver.feed("user1", Time.now.to_i, {"id" => 1, "name" => "new_user1", "hoge" => "bar1"})
+        driver.feed("user1", Time.now.to_i, {"id" => 3, "hoge" => "bar3"})
+        driver.feed("user1", Time.now.to_i, {"id" => 4, "name" => "new_user4", "hoge" => "bar4"})
+      end
+      assert_equal(3, driver.events.size)
+      event1 = driver.events[0]
+      event2 = driver.events[1]
+      event3 = driver.events[2]
+
+      assert_equal("new_tag", event1[0])
+      assert_kind_of(Fluent::EventTime, event1[1])
+      assert_equal({"id" => 1, "foo" => 1, "name" => "user1"}, event1[2])
+      assert_equal({"id" => 3, "foo" => 3, "name" => "user3"}, event2[2])
+      assert_equal({"id" => 4, "foo" => 4, "name" => "user1"}, event3[2])
+    end
+
+    test "fluentd_record.merge(mysql_record)" do
+      mysql_client.query("INSERT INTO users (id, name) VALUES (4, 'user1')")
+      driver = create_driver(CONFIG + "\n" + <<~CONF)
+        <buffer tag>
+        </buffer>
+        merge_priority mysql
+
+        <record_matching_key>
+          fluentd_record_key id
+          mysql_record_key foo
+        </record_matching_key>
+      CONF
+
+      driver.run do
+        driver.feed("user1", Time.now.to_i, {"id" => 1, "name" => "new_user1", "hoge" => "bar1"})
+        driver.feed("user1", Time.now.to_i, {"id" => 3, "hoge" => "bar3"})
+        driver.feed("user1", Time.now.to_i, {"id" => 4, "name" => "new_user4", "hoge" => "bar4"})
+      end
+      assert_equal(3, driver.events.size)
+      event1 = driver.events[0]
+      event2 = driver.events[1]
+      event3 = driver.events[2]
+
+      assert_equal("new_tag", event1[0])
+      assert_kind_of(Fluent::EventTime, event1[1])
+      assert_equal({"id" => 1, "foo" => 1, "name" => "user1", "hoge" => "bar1"}, event1[2])
+      assert_equal({"id" => 3, "foo" => 3, "name" => "user3", "hoge" => "bar3"}, event2[2])
+      assert_equal({"id" => 4, "foo" => 4, "name" => "user1", "hoge" => "bar4"}, event3[2])
+    end
+
+    test "fluentd_record.merge(mysql_record) with remove_keys" do
+      mysql_client.query("INSERT INTO users (id, name) VALUES (4, 'user1')")
+      driver = create_driver(CONFIG + "\n" + <<~CONF)
+        <buffer tag>
+        </buffer>
+        merge_priority mysql
+
+        <record_matching_key>
+          fluentd_record_key id
+          mysql_record_key foo
+        </record_matching_key>
+
+        remove_keys name, hoge
+      CONF
+
+      driver.run do
+        driver.feed("user1", Time.now.to_i, {"id" => 1, "name" => "new_user1", "hoge" => "bar1"})
+        driver.feed("user1", Time.now.to_i, {"id" => 3, "hoge" => "bar3"})
+        driver.feed("user1", Time.now.to_i, {"id" => 4, "name" => "new_user4", "hoge" => "bar4"})
+      end
+      assert_equal(3, driver.events.size)
+      event1 = driver.events[0]
+      event2 = driver.events[1]
+      event3 = driver.events[2]
+
+      assert_equal("new_tag", event1[0])
+      assert_kind_of(Fluent::EventTime, event1[1])
+      assert_equal({"id" => 1, "foo" => 1, "name" => "user1"}, event1[2])
+      assert_equal({"id" => 3, "foo" => 3, "name" => "user3"}, event2[2])
+      assert_equal({"id" => 4, "foo" => 4, "name" => "user1"}, event3[2])
+    end
+  end
+
+  private
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::MysqlFetchAndEmitOutput).configure(conf)
+  end
+
+  def mysql_client
+    Mysql2::Client.new(host: "127.0.0.1", username: "root", password: "", database: "sample")
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mysql-fetch-and-emit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-09 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'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: Fluentd plugin to fetch record by input data, and to emit the record
+  data.
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-mysql-fetch-and-emit.gemspec
+- lib/fluent/plugin/out_mysql_fetch_and_emit.rb
+- test/helper.rb
+- test/plugin/test_out_mysql_fetch_and_emit.rb
+homepage: https://github.com/joker1007/fluent-plugin-mysql-fetch-and-emit
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to fetch record by input data, and to emit the record data.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mysql_fetch_and_emit.rb