fluent-plugin-mqtt-io 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 910f2e9e505f0b9ae26ac26f29357a849b2e11df
-  data.tar.gz: ede83bec8dac5beda12524e0ba2d939460c664da
+  metadata.gz: 57a1a03befc225ac307f35c2ad9d5043c5be180b
+  data.tar.gz: 1b457000a1bfefa873c1e6fa7e576f0fc3a35870
 SHA512:
-  metadata.gz: 8f40b5f402574cf81877f0bfd70a9d9331f724e0b3b667b9404f9d71e4cf732c3321200b219f1922e9cae835543f2a8c2cec55c3e2b33018f376e5277a09773d
-  data.tar.gz: 81e7227607e0ed5d95fc33b4e4015a5c1e323813a6c8604259cbcf578a74b7c7f89879d872e0e39d86062031c8c67540edcef84be8a2d4808f4f99e2d0255f24
+  metadata.gz: 80d14876fb728ca4ec6ff0df74454cbba3d46d992fd13673b7f169eefca0b96e3b53c854a46cdc44f768c465134d01569441b4f964efaeb3ac1018993533c937
+  data.tar.gz: 53fbdc544df75db543d8bdab4d5c8e49257efc991f97ffdf215e9ada7e032f3ee108884642f20a71f834dc35f37ee3ade264eec4eea7a0102e3c4fc2657cb787

data/README.md

@@ -64,7 +64,7 @@ The default MQTT topic is "#". Configurable options are the following:
 - **host**: IP address of MQTT broker
 - **port**: Port number of MQTT broker
 - **client_id**: Client ID that to connect to MQTT broker
-- **parser**: Parser plugin can be specified ![Parser Plugin](https://docs.fluentd.org/v1.0/articles/parser-plugin-overview)
+- **parser**: Parser plugin can be specified [Parser Plugin](https://docs.fluentd.org/v1.0/articles/parser-plugin-overview)
 - **topic**: Topic name to be subscribed
 - **security**
   - **username**: User name for authentication
@@ -109,13 +109,13 @@ The options are basically the same as Input Plugin except for "parser (for Input
   If this option is omitted, timestamp field is not appended to the output record.
 - **topic_rewrite_pattern**: Regexp pattern to extract replacement words from received topic or tag name
 - **topic_rewrite_replacement**: Topic name used for the publish using extracted pattern
-- **format**: Formatter plugin can be specified. ![Formatter Plugin](https://docs.fluentd.org/v1.0/articles/formatter-plugin-overview)
+- **format**: Formatter plugin can be specified. [Formatter Plugin](https://docs.fluentd.org/v1.0/articles/formatter-plugin-overview)
 - **monitor**: monitor section. only for fluent-plugin-mqtt-io
   - **send_time**: Add send time to message in millisecond (ms) as integer for debug and performance/delay analysis. only for fluent-plugin-mqtt-io
   - **send_time_key**: An attribute of send_time. only for fluent-plugin-mqtt-io
   - **time_type**: Type of time format (string (default), unixtime, float) only for fluent-plugin-mqtt-io
   - **time_format**: Time format e.g. %FT%T.%N%:z (refer strftime) only for fluent-plugin-mqtt-io
-- **buffer**: synchronous/asynchronous buffer is supported. Refer ![Buffer section configurations](https://docs.fluentd.org/v1.0/articles/buffer-section) for detailed configuration.
+- **buffer**: synchronous/asynchronous buffer is supported. Refer [Buffer section configurations](https://docs.fluentd.org/v1.0/articles/buffer-section) for detailed configuration.
   - **async**: Enable asynchronous buffer transfer. Default is false.
 
 If you use different source, e.g. the other MQTT broker, log file and so on, there is no need to specifie topic rewriting. Skip the following descriptions.

data/fluent-plugin-mqtt-io.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-mqtt-io"
-  spec.version       = "0.4.1"
+  spec.version       = "0.4.2"
   spec.authors       = ["Toyokazu Akiyama"]
   spec.email         = ["toyokazu@gmail.com"]
 

data/lib/fluent/plugin/mqtt_proxy.rb

@@ -40,8 +40,7 @@ module Fluent::Plugin
       end
     end
 
-    class MqttProxyError
-    end
+    class MqttError < StandardError; end
 
     def current_plugin_name
       # should be implemented
@@ -84,12 +83,15 @@ module Fluent::Plugin
     end
 
     def retry_connect(e, message)
-      log.error "#{message},#{e.class},#{e.message}"
-      log.error "Retry in #{@retry_interval} sec"
-      timer_execute("#{current_plugin_name}_connect".to_sym, @retry_interval, repeat: false, &method(:connect))
-      increment_retry_interval
-      after_disconnection
-      @client.disconnect if @client.connected?
+      if !@_retrying
+        log.error "#{message},#{e.class},#{e.message}"
+        log.error "Retry in #{@retry_interval} sec"
+        timer_execute("#{current_plugin_name}_connect".to_sym, @retry_interval, repeat: false, &method(:connect))
+        @_retrying = true
+        increment_retry_interval
+        after_disconnection
+        @client.disconnect if @client.connected?
+      end
     end
 
     def kill_connect_thread
@@ -102,25 +104,37 @@ module Fluent::Plugin
     end
 
     def rescue_disconnection
+      # Errors cannot be caught by fluentd core must be caught here.
+      # Since fluentd core retries write method for buffered output 
+      # when it caught Errors during the previous write,
+      # caughtable Error, e.g. MqttError, should be raised here.
       begin
         yield
       rescue MQTT::ProtocolException => e
         # TODO:
-        # Currently MQTT::ProtocolException cannot be caught during @client.get
-        # and @client.publish. The reason must be investigated...
-        retry_connect(e, "Protocol error occurs.")
+        # Thread created via fluentd thread API, e.g. thread_create,
+        # cannot catch MQTT::ProtocolException raised from @read_thread
+        # in ruby-mqtt. So, the current version uses plugin local thread
+        # @connect_thread to catch it.
+        retry_connect(e, "Protocol error occurs in #{current_plugin_name}.")
+        raise MqttError, "Protocol error occurs."
       rescue Timeout::Error => e
-        retry_connect(e, "Timeout error occurs.")
+        retry_connect(e, "Timeout error occurs in #{current_plugin_name}.")
+        raise Timeout::Error, "Timeout error occurs."
       rescue SystemCallError => e
-        retry_connect(e, "System call error occurs.")
+        retry_connect(e, "System call error occurs in #{current_plugin_name}.")
+        raise SystemCallError, "System call error occurs."
       rescue StandardError=> e
-        retry_connect(e, "The other error occurs.")
+        retry_connect(e, "The other error occurs in #{current_plugin_name}.")
+        raise StandardError, "The other error occurs."
       rescue MQTT::NotConnectedException=> e
         # Since MQTT::NotConnectedException is raised only on publish,
         # connection error should be catched before this error.
         # So, reconnection process is omitted for this Exception
         # to prevent waistful increment of retry interval.
-        log.error "MQTT not connected exception occurs.,#{e.class},#{e.message}"
+        #log.error "MQTT not connected exception occurs.,#{e.class},#{e.message}"
+        #retry_connect(e, "MQTT not connected exception occurs.")
+        raise MqttError, "MQTT not connected exception occurs in #{current_plugin_name}."
       end
     end
 
@@ -132,6 +146,7 @@ module Fluent::Plugin
 
     def connect
       #@connect_thread = thread_create("#{current_plugin_name}_monitor".to_sym) do
+      @_retrying = false
       @connect_thread = Thread.new do
         rescue_disconnection do
           @client.connect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mqtt-io
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Toyokazu Akiyama
 autorequire: 
 bindir: []
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: fluentd input/output plugin for mqtt broker