fluent-plugin-mqtt-io 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1403811416a6ec5ae4b65f1e2f910425c78464f
-  data.tar.gz: 36025a84dafc6aacc2295c76cd0a9f8110563514
+  metadata.gz: c1ec56bcb964c914765afcd471b69413e623a54d
+  data.tar.gz: d7784e5b1e39d416cec4b40a1868ca72fe0f3afc
 SHA512:
-  metadata.gz: 64ae726ba5f10ba20d16692626cd9ce1d6424fe1a0aacd735fbacd73f3bf3c927c07838980907e9bb5ef89b3227eb7c03b64b82979de5df3825e168a5a58d5c8
-  data.tar.gz: 9501641e21422a5fa755550a1e9a32427515e03ef9cfd3721095bbcdb2d6d806e03e36d71b35a1a8d334696a6d7f5e42127145e4bbad970bb89562f4c83ce2a6
+  metadata.gz: 62e831aece6900ea1b8f3b8b98fae4cf0391c2bf223803dba5ba8aecd2182c103172523793721ab25bf5279f266e193a3dd4bf86b79167c51b197d44e9ea9475
+  data.tar.gz: 3efb8116780288682a990f56c98b4b338a7823e037f9a5088e62071d537b9d2e330841bb06fb68b4adb02ac90ffd93382b1694ef13557cb288326795a3f2c167

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.3.0 (2017-03-20)
+
+Features:
+  - compatible with fluentd v0.14
+  - change license from MIT License to Apache License Version 2.0
+
+Deprecations:
+
+  - deprecated support of fluentd v0.12

data/LICENSE

@@ -1,22 +1,191 @@
-The MIT License (MIT)
 
-Copyright (c) 2015 Toyokazu Akiyama
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
 
-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:
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+   1. Definitions.
 
-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.
+      "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
+
+   Copyright 2015-2017 Toyokazu Akiyama
+
+   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
+
+       https://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

@@ -240,4 +240,4 @@ MQTT output plugin can be used as the following. If you have tiny computers like
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
 task :default => :test

data/fluent-plugin-mqtt-io.gemspec

@@ -4,14 +4,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-mqtt-io"
-  spec.version       = "0.2.3"
+  spec.version       = "0.3.0"
   spec.authors       = ["Toyokazu Akiyama"]
   spec.email         = ["toyokazu@gmail.com"]
 
   spec.summary       = %q{fluentd input/output plugin for mqtt broker}
   spec.description   = %q{fluentd input/output plugin for mqtt broker}
   spec.homepage      = "https://github.com/toyokazu/fluent-plugin-mqtt-io"
-  spec.license       = "MIT"
+  spec.license       = "Apache License Version 2.0"
 
   spec.files         = `git ls-files`.gsub(/images\/[\w\.]+\n/, "").split($/)
   spec.bindir        = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -19,9 +19,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'fluentd', '>= 0.10.0'
-  spec.add_dependency "mqtt", "~> 0.3"
+  spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'fluentd', '~> 0.14'
+  spec.add_dependency "mqtt", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit"
 end

data/lib/fluent/plugin/in_mqtt.rb

@@ -1,30 +1,59 @@
-module Fluent
+require 'fluent/plugin/input'
+require 'fluent/event'
+require 'fluent/time'
+require 'mqtt'
+
+module Fluent::Plugin
   class MqttInput < Input
-    Plugin.register_input('mqtt', self)
+    Fluent::Plugin.register_input('mqtt', self)
+
+    helpers :thread, :compat_parameters, :parser
+
+    MQTT_PORT = 1883
 
-    config_param :port, :integer, :default => 1883
+    desc 'The address to connect to.'
     config_param :host, :string, :default => '127.0.0.1'
+    desc 'The port to connect to.'
+    config_param :port, :integer, :default => MQTT_PORT
+    desc 'The topic to subscribe.'
     config_param :topic, :string, :default => '#'
+    desc 'The format to receive.'
     config_param :format, :string, :default => 'json'
-    config_param :bulk_trans, :bool, :default => true
-    config_param :bulk_trans_sep, :string, :default => "\t"
-    config_param :username, :string, :default => nil
-    config_param :password, :string, :default => nil
+    desc 'Specify keep alive interval.'
     config_param :keep_alive, :integer, :default => 15
-    config_param :ssl, :bool, :default => nil
-    config_param :ca_file, :string, :default => nil
-    config_param :key_file, :string, :default => nil
-    config_param :cert_file, :string, :default => nil
-    config_param :recv_time, :bool, :default => false
-    config_param :recv_time_key, :string, :default => "recv_time"
+    desc 'Specify initial interval for reconnection.'
     config_param :initial_interval, :integer, :default => 1
+    desc 'Specify increasing ratio of reconnection interval.'
     config_param :retry_inc_ratio, :integer, :default => 2
 
-    require 'mqtt'
+    # bulk_trans is deprecated
+    # multiple entries must be inputted as an Array
+    #config_param :bulk_trans, :bool, :default => true
+    #config_param :bulk_trans_sep, :string, :default => "\t"
+
+    config_section :security, required: false, multi: false do
+      ### User based authentication
+      desc 'The username for authentication'
+      config_param :username, :string, :default => nil
+      desc 'The password for authentication'
+      config_param :password, :string, :default => nil
+      desc 'Use TLS or not.'
+      config_param :use_tls, :bool, :default => nil
+      config_section :tls, required: false, multi: true do
+        desc 'Specify TLS ca file.'
+        config_param :ca_file, :string, :default => nil
+        desc 'Specify TLS key file.'
+        config_param :key_file, :string, :default => nil
+        desc 'Specify TLS cert file.'
+        config_param :cert_file, :string, :default => nil
+      end
+    end
 
-    # Define `router` method of v0.12 to support v0.10 or earlier
-    unless method_defined?(:router)
-      define_method("router") { Fluent::Engine }
+    config_section :monitor, required: false, multi: false do
+      desc 'Record received time into message or not.'
+      config_param :recv_time, :bool, :default => false
+      desc 'Specify the attribute name of received time.'
+      config_param :recv_time_key, :string, :default => "recv_time"
     end
 
     def configure(conf)
@@ -34,10 +63,11 @@ module Fluent
     end
 
     def configure_parser(conf)
-      @parser = Plugin.new_parser(conf['format'])
-      @parser.configure(conf)
+      compat_parameters_convert(conf, :parser)
+      parser_config = conf.elements('parse').first
+      @parser = parser_create(conf: parser_config)
     end
-    
+
     def init_retry_interval
       @retry_interval = @initial_interval
     end
@@ -58,46 +88,51 @@ module Fluent
       opts = {
         host: @host,
         port: @port,
-        username: @username,
-        password: @password,
         keep_alive: @keep_alive
       }
-      opts[:ssl] = @ssl if @ssl
-      opts[:ca_file] = @ca_file if @ca_file
-      opts[:cert_file] = @cert_file if @cert_file
-      opts[:key_file] = @key_file if @key_file
+      opts[:username] = @security.username if @security.respond_to?(:username)
+      opts[:password] = @security.password if @security.respond_to?(:password)
+      if @security.respond_to?(:use_tls) && @security.use_tls
+        opts[:ssl] = @security.use_tls
+        opts[:ca_file] = @security.tls.ca_file
+        opts[:cert_file] = @security.tls.cert_file
+        opts[:key_file] = @security.tls.key_file
+      end
 
       # In order to handle Exception raised from reading Thread
       # in MQTT::Client caused by network disconnection (during read_byte),
       # @connect_thread generates connection.
       @client = MQTT::Client.new(opts)
-      @connect_thread = Thread.new do
-        while (true)
-          begin
-            @client.disconnect if @client.connected?
-            @client.connect
-            @client.subscribe(@topic)
-            @get_thread.kill if !@get_thread.nil? && @get_thread.alive?
-            @get_thread = Thread.new do
-              @client.get do |topic, message|
-                emit(topic, message)
-              end
+      @get_thread = nil
+      @connect_thread = Thread.new(&method(:connect_loop))
+    end
+
+    def connect_loop
+      while (true)
+        begin
+          @get_thread.kill if !@get_thread.nil? && @get_thread.alive?
+          @client.disconnect if @client.connected?
+          @client.connect
+          @client.subscribe(@topic)
+          @get_thread = Thread.new do
+            @client.get do |topic, message|
+              emit(topic, message)
             end
-            init_retry_interval
-            sleep
-          rescue MQTT::ProtocolException => e
-            sleep_retry_interval(e, "Protocol error occurs.")
-            next
-          rescue Timeout::Error => e
-            sleep_retry_interval(e, "Timeout error occurs.")
-            next
-          rescue SystemCallError => e
-            sleep_retry_interval(e, "System call error occurs.")
-            next
-          rescue StandardError=> e
-            sleep_retry_interval(e, "The other error occurs.")
-            next
           end
+          init_retry_interval
+          sleep
+        rescue MQTT::ProtocolException => e
+          sleep_retry_interval(e, "Protocol error occurs.")
+          next
+        rescue Timeout::Error => e
+          sleep_retry_interval(e, "Timeout error occurs.")
+          next
+        rescue SystemCallError => e
+          sleep_retry_interval(e, "System call error occurs.")
+          next
+        rescue StandardError=> e
+          sleep_retry_interval(e, "The other error occurs.")
+          next
         end
       end
     end
@@ -105,7 +140,7 @@ module Fluent
     def add_recv_time(record)
       if @recv_time
         # recv_time is recorded in ms
-        record.merge({@recv_time_key => Time.now.instance_eval { self.to_i * 1000 + (usec/1000) }})
+        record.merge({@recv_time_key => Fluent::EventTime.now})
       else
         record
       end
@@ -114,8 +149,8 @@ module Fluent
     def parse(message)
       @parser.parse(message) do |time, record|
         if time.nil?
-          $log.debug "Since time_key field is nil, Fluent::Engine.now is used."
-          time = Fluent::Engine.now
+          $log.debug "Since time_key field is nil, Fluent::EventTime.now is used."
+          time = Fluent::EventTime.now
         end
         $log.debug "#{topic}, #{time}, #{add_recv_time(record)}"
         return [time, add_recv_time(record)]
@@ -124,13 +159,16 @@ module Fluent
 
     def emit(topic, message)
       begin
-        topic.gsub!("/","\.")
-        if @bulk_trans
-          message.split(@bulk_trans_sep).each do |m|
-            router.emit(topic, *parse(m))
+        tag = topic.gsub("/","\.")
+        time, record = parse(message)
+        if record.is_a?(Array)
+          mes = Fluent::MultiEventStream.new
+          record.each do |single_record|
+            mes.add(@parser.parse_time(single_record), single_record)
           end
+          router.emit_stream(tag, mes)
         else
-          router.emit(topic, *parse(message))
+          router.emit(tag, time, record)
         end
       rescue Exception => e
         $log.error :error => e.to_s

data/lib/fluent/plugin/out_mqtt.rb

@@ -1,20 +1,225 @@
-module Fluent
-  class MqttOutput < Output
-    require 'fluent/plugin/mqtt_output_mixin'
-    include Fluent::MqttOutputMixin
+require 'fluent/plugin/output'
+require 'fluent/event'
+require 'fluent/time'
+require 'mqtt'
 
-    # First, register the plugin. NAME is the name of this plugin
-    # and identifies the plugin in the configuration file.
+module Fluent::Plugin
+  class MqttOutput < Output
     Fluent::Plugin.register_output('mqtt', self)
 
-    def emit(tag, es, chain)
-      es.each {|time,record|
-        $log.debug "#{tag}, #{format_time(time)}, #{add_send_time(record)}"
-        @client.publish(rewrite_tag(tag), add_send_time(record).merge(timestamp_hash(time)).to_json)
+    helpers :compat_parameters, :formatter, :inject
+
+    MQTT_PORT = 1883
+
+    desc 'The address to connect to.'
+    config_param :host, :string, :default => '127.0.0.1'
+    desc 'The port to connect to.'
+    config_param :port, :integer, :default => MQTT_PORT
+    desc 'MQTT keep alive interval.'
+    config_param :keep_alive, :integer, :default => 15
+    desc 'Topic rewrite matching pattern.'
+    config_param :topic_rewrite_pattern, :string, :default => nil
+    desc 'Topic rewrite replacement string.'
+    config_param :topic_rewrite_replacement, :string, :default => nil
+    desc 'Initial retry interval.'
+    config_param :initial_interval, :integer, :default => 1
+    desc 'Increasing ratio of retry interval.'
+    config_param :retry_inc_ratio, :integer, :default => 2
+
+    config_section :security, required: false, multi: false do
+      ### User based authentication
+      desc 'The username for authentication'
+      config_param :username, :string, :default => nil
+      desc 'The password for authentication'
+      config_param :password, :string, :default => nil
+      desc 'Use TLS or not.'
+      config_param :use_tls, :bool, :default => nil
+      config_section :tls, required: false, multi: true do
+        desc 'TLS ca file.'
+        config_param :ca_file, :string, :default => nil
+        desc 'TLS key file.'
+        config_param :key_file, :string, :default => nil
+        desc 'TLS cert file.'
+        config_param :cert_file, :string, :default => nil
+      end
+    end
+
+    config_section :monitor, required: false, multi: false do
+      desc 'Recording send time for monitoring.'
+      config_param :send_time, :bool, :default => false
+      desc 'Recording key name of send time for monitoring.'
+      config_param :send_time_key, :string, :default => "send_time"
+    end
+
+    # This method is called before starting.
+    # 'conf' is a Hash that includes configuration parameters.
+    # If the configuration is invalid, raise Fluent::ConfigError.
+    def configure(conf)
+      super
+      compat_parameters_convert(conf, :formatter, :inject, :buffer, default_chunk_key: "time")
+      formatter_config = conf.elements(name: 'format').first
+      @formatter = formatter_create(conf: formatter_config)
+      @has_buffer_section = conf.elements(name: 'buffer').size > 0
+      init_retry_interval
+    end
+
+    def init_retry_interval
+      @retry_interval = @initial_interval
+    end
+
+    def increment_retry_interval
+      @retry_interval = @retry_interval * @retry_inc_ratio
+    end
+
+    def sleep_retry_interval(e, message)
+      $log.error "#{message},#{e.class},#{e.message}"
+      $log.error "Retry in #{@retry_interval} sec"
+      sleep @retry_interval
+      increment_retry_interval
+    end
+
+    def rewrite_tag(tag)
+      if @topic_rewrite_pattern.nil?
+        tag.gsub("\.", "/")
+      else
+        tag.gsub("\.", "/").gsub(Regexp.new(@topic_rewrite_pattern), @topic_rewrite_replacement)
+      end
+    end
+
+    def prefer_buffered_processing
+      @has_buffer_section
+    end
+
+    # This method is called when starting.
+    # Open sockets or files here.
+    def start
+      super
+
+      $log.debug "start to connect mqtt broker #{@host}:#{@port}"
+      opts = {
+        host: @host,
+        port: @port,
+        keep_alive: @keep_alive
       }
+      opts[:username] = @security.username if @security.respond_to?(:username)
+      opts[:password] = @security.password if @security.respond_to?(:password)
+      if @security.respond_to?(:use_tls) && @security.use_tls
+        opts[:ssl] = @security.use_tls
+        opts[:ca_file] = @security.tls.ca_file
+        opts[:cert_file] = @security.tls.cert_file
+        opts[:key_file] = @security.tls.key_file
+      end
+      # In order to handle Exception raised from reading Thread
+      # in MQTT::Client caused by network disconnection (during read_byte),
+      # @connect_thread generates connection.
+      @client_mutex = Mutex.new
+      @client = MQTT::Client.new(opts)
+      connect_loop
+    end
+
+    # This method is called when shutting down.
+    # Shutdown the thread and close sockets or files here.
+    def shutdown
+      super
+
+      @client.disconnect
+    end
+
+    def connect_loop
+      while (true)
+        @client_mutex.lock
+        begin
+          @client.disconnect if @client.connected?
+          @client.connect
+          init_retry_interval
+        rescue MQTT::ProtocolException => e
+          sleep_retry_interval(e, "Protocol error occurs.")
+          @client_mutex.unlock
+          next
+        rescue Timeout::Error => e
+          sleep_retry_interval(e, "Timeout error occurs.")
+          @client_mutex.unlock
+          next
+        rescue SystemCallError => e
+          sleep_retry_interval(e, "System call error occurs.")
+          @client_mutex.unlock
+          next
+        rescue StandardError=> e
+          sleep_retry_interval(e, "The other error occurs.")
+          @client_mutex.unlock
+          next
+        end
+        @client_mutex.unlock
+        break
+      end
+    end
+
+    def publish_error_handler
+      while(true)
+        begin
+          yield
+        rescue MQTT::ProtocolException => e
+          sleep_retry_interval(e, "Protocol error occurs.")
+          connect_loop
+          next
+        rescue Timeout::Error => e
+          sleep_retry_interval(e, "Timeout error occurs.")
+          connect_loop
+          next
+        rescue SystemCallError => e
+          sleep_retry_interval(e, "System call error occurs.")
+          connect_loop
+          next
+        rescue StandardError=> e
+          sleep_retry_interval(e, "The other error occurs.")
+          connect_loop
+          next
+        end
+        break
+      end
+    end
+
+    def add_send_time(record)
+      if @send_time
+        # send_time is recorded in ms
+        record.merge({@send_time_key => Fluent::EventTime.now})
+      else
+        record
+      end
+    end
+
+    def publish_event_stream(tag, es)
+      if es.class == Fluent::OneEventStream
+        es = inject_values_to_event_stream(tag, es)
+        es.each do |time, record|
+          $log.debug "#{rewrite_tag(tag)}, #{add_send_time(record)}"
+          publish_error_handler do
+            @client.publish(rewrite_tag(tag), @formatter.format(tag, time, add_send_time(record)))
+          end
+        end
+      else
+        es = inject_values_to_event_stream(tag, es)
+        array = []
+        es.each do |time, record|
+          $log.debug "#{rewrite_tag(tag)}, #{add_send_time(record)}"
+          array << add_send_time(record)
+        end
+        publish_error_handler do
+          @client.publish(rewrite_tag(tag), @formatter.format(tag, Fluent::EventTime.now, array))
+        end
+      end
       $log.flush
+    end
+
+    def process(tag, es)
+      publish_event_stream(tag, es)
+    end
+
+    def write(chunk)
+      return if chunk.empty?
+      tag = chunk.metadata.tag
 
-      chain.next
+      publish_event_stream(tag, es)
     end
   end
 end

data/test/plugin/test_in_mqtt.rb

@@ -0,0 +1,32 @@
+require_relative '../helper'
+require 'fluent/test/driver/input'
+require 'fluent/plugin/in_mqtt'
+
+class MqttInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+
+  CONFIG = %[
+  ]
+
+  def create_driver(conf = CONFIG, opts = {}) 
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::MqttInput, opts: opts).configure(conf)
+  end
+
+  sub_test_case "configure" do
+    test "host and port" do
+      d = create_driver %[
+          host 127.0.0.1
+          port 1300
+          <parse>
+            @type json
+            time_format %FT%T%:z
+          </parse>
+      ]
+      assert_equal '127.0.0.1', d.instance.host
+      assert_equal 1300, d.instance.port
+    end
+  end
+end

data/test/plugin/test_out_mqtt.rb

@@ -0,0 +1,31 @@
+require_relative '../helper'
+require 'fluent/test/driver/output'
+require 'fluent/plugin/out_mqtt'
+
+class MqttOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+
+  CONFIG = %[
+  ]
+
+  def create_driver(conf = CONFIG, opts = {}) 
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::MqttOutput, opts: opts).configure(conf)
+  end
+
+  sub_test_case 'non-buffered' do
+    test 'configure' do
+      d = create_driver %[
+        host 127.0.0.1
+        port 1300
+        <format>
+          @type json
+        </format>
+      ]
+      assert_equal '127.0.0.1', d.instance.host
+      assert_equal 1300, d.instance.port
+    end
+  end
+end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mqtt-io
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Toyokazu Akiyama
 autorequire: 
 bindir: []
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2017-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: mqtt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.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: fluentd input/output plugin for mqtt broker
 email:
 - toyokazu@gmail.com
@@ -75,19 +89,20 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - fluent-plugin-mqtt-io.gemspec
 - lib/fluent/plugin/in_mqtt.rb
-- lib/fluent/plugin/mqtt_output_mixin.rb
 - lib/fluent/plugin/out_mqtt.rb
-- lib/fluent/plugin/out_mqtt_buf.rb
 - test/helper.rb
+- test/plugin/test_in_mqtt.rb
+- test/plugin/test_out_mqtt.rb
 homepage: https://github.com/toyokazu/fluent-plugin-mqtt-io
 licenses:
-- MIT
+- Apache License Version 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -97,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -105,9 +120,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: fluentd input/output plugin for mqtt broker
 test_files:
 - test/helper.rb
+- test/plugin/test_in_mqtt.rb
+- test/plugin/test_out_mqtt.rb

data/lib/fluent/plugin/mqtt_output_mixin.rb

@@ -1,155 +0,0 @@
-module Fluent
-  module MqttOutputMixin
-    # config_param defines a parameter. You can refer a parameter via @path instance variable
-    # Without :default, a parameter is required.
-
-    def self.included(base)
-      base.config_param :port, :integer, :default => 1883
-      base.config_param :host, :string, :default => '127.0.0.1'
-      base.config_param :username, :string, :default => nil
-      base.config_param :password, :string, :default => nil
-      base.config_param :keep_alive, :integer, :default => 15
-      base.config_param :ssl, :bool, :default => nil
-      base.config_param :ca_file, :string, :default => nil
-      base.config_param :key_file, :string, :default => nil
-      base.config_param :cert_file, :string, :default => nil
-      base.config_param :time_key, :string, :default => 'time'
-      base.config_param :time_format, :string, :default => nil
-      base.config_param :topic_rewrite_pattern, :string, :default => nil
-      base.config_param :topic_rewrite_replacement, :string, :default => nil
-      base.config_param :bulk_trans_sep, :string, :default => "\t"
-      base.config_param :send_time, :bool, :default => false
-      base.config_param :send_time_key, :string, :default => "send_time"
-      base.config_param :initial_interval, :integer, :default => 1
-      base.config_param :retry_inc_ratio, :integer, :default => 2
-    end
-
-    require 'mqtt'
-
-    # This method is called before starting.
-    # 'conf' is a Hash that includes configuration parameters.
-    # If the configuration is invalid, raise Fluent::ConfigError.
-    def configure(conf)
-      super
-      init_retry_interval
-    end
-
-    def init_retry_interval
-      @retry_interval = @initial_interval
-    end
-
-    def increment_retry_interval
-      @retry_interval = @retry_interval * @retry_inc_ratio
-    end
-
-    def sleep_retry_interval(e, message)
-      $log.error "#{message},#{e.class},#{e.message}"
-      $log.error "Retry in #{@retry_interval} sec"
-      sleep @retry_interval
-      increment_retry_interval
-    end
-
-    # This method is called when starting.
-    # Open sockets or files here.
-    def start
-      super
-
-      $log.debug "start mqtt #{@host}"
-      opts = {
-        host: @host,
-        port: @port,
-        username: @username,
-        password: @password,
-        keep_alive: @keep_alive
-      }
-      opts[:ssl] = @ssl if @ssl
-      opts[:ca_file] = @ca_file if @ca_file
-      opts[:cert_file] = @cert_file if @cert_file
-      opts[:key_file] = @key_file if @key_file
-      # In order to handle Exception raised from reading Thread
-      # in MQTT::Client caused by network disconnection (during read_byte),
-      # @connect_thread generates connection.
-      @client = MQTT::Client.new(opts)
-      @connect_thread = Thread.new do
-        while (true)
-          begin
-            @client.disconnect if @client.connected?
-            @client.connect
-            init_retry_interval
-            sleep
-          rescue MQTT::ProtocolException => e
-            sleep_retry_interval(e, "Protocol error occurs.")
-            next
-          rescue Timeout::Error => e
-            sleep_retry_interval(e, "Timeout error occurs.")
-            next
-          rescue SystemCallError => e
-            sleep_retry_interval(e, "System call error occurs.")
-            next
-          rescue StandardError=> e
-            sleep_retry_interval(e, "The other error occurs.")
-            next
-          end
-        end
-      end
-    end
-
-    # This method is called when shutting down.
-    # Shutdown the thread and close sockets or files here.
-    def shutdown
-      super
-
-      @client.disconnect
-    end
-
-    def format_time(time)
-      case @time_format
-      when nil then
-        # default format is integer value
-        time
-      when "iso8601" then
-        # iso8601 format
-        Time.at(time).iso8601
-      else
-        # specified strftime format
-        Time.at(time).strftime(@time_format)
-      end
-    end
-
-    def timestamp_hash(time)
-      if @time_key.nil?
-        {}
-      else
-        {@time_key => format_time(time)}
-      end
-    end
-
-    def add_send_time(record)
-      if @send_time
-        # send_time is recorded in ms
-        record.merge({@send_time_key => Time.now.instance_eval { self.to_i * 1000 + (usec/1000) }})
-      else
-        record
-      end
-    end
-                  
-
-    def rewrite_tag(tag)
-      if @topic_rewrite_pattern.nil?
-        tag.gsub("\.", "/")
-      else
-        tag.gsub("\.", "/").gsub(Regexp.new(@topic_rewrite_pattern), @topic_rewrite_replacement)
-      end
-    end
-
-    def json_parse(message)
-      begin
-        y = Yajl::Parser.new
-        y.parse(message)
-      rescue
-        $log.error "JSON parse error", :error => $!.to_s, :error_class => $!.class.to_s
-        $log.warn_backtrace $!.backtrace
-      end
-    end
-  end
-end

data/lib/fluent/plugin/out_mqtt_buf.rb

@@ -1,36 +0,0 @@
-module Fluent
-  class MqttBufferedOutput < BufferedOutput
-    require 'fluent/plugin/mqtt_output_mixin'
-    include Fluent::MqttOutputMixin
-
-    # First, register the plugin. NAME is the name of this plugin
-    # and identifies the plugin in the configuration file.
-    Fluent::Plugin.register_output('mqtt_buf', self)
-
-    # This method is called when an event reaches to Fluentd.
-    # Convert the event to a raw string.
-    def format(tag, time, record)
-      [tag, time, record].to_msgpack
-    end
-
-    # This method is called every flush interval. Write the buffer chunk
-    # to files or databases here.
-    # 'chunk' is a buffer chunk that includes multiple formatted
-    # events. You can use 'data = chunk.read' to get all events and
-    # 'chunk.open {|io| ... }' to get IO objects.
-    #
-    # NOTE! This method is called by internal thread, not Fluentd's main thread. So IO wait doesn't affect other plugins.
-    def write(chunk)
-      messages = {}
-      chunk.msgpack_each do |tag, time, record|
-        messages[tag] = [] if messages[tag].nil?
-        messages[tag] << add_send_time(record).merge(timestamp_hash(time))
-      end
-      messages.keys.each do |tag|
-        $log.debug "Thread ID: #{Thread.current.object_id}, topic: #{rewrite_tag(tag)}, message: #{messages[tag]}"
-        @client.publish(rewrite_tag(tag), messages[tag].map {|m| m.to_json}.join(@bulk_trans_sep))
-      end
-      $log.flush
-    end
-  end
-end