logstash-output-mqtt 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c13e7a4156045d08c121c0de23f4eaa1a4bce1995b2d079abb4dd15ac7d5c1d9
-  data.tar.gz: 610ddd709836340d87c55ce1ecc2ef145ca6c6e447d8a9688e55d4f775639457
+  metadata.gz: 69b541cd6a2abd62541b3500c13cafdd67c2ea83270fcdfbbcc923dee527a0d9
+  data.tar.gz: e1696a7ecffef182fac7aff34e57def48983ba8dc064ba7504ddb61ef2a5db31
 SHA512:
-  metadata.gz: f98f37cd1a440228baf58e576765eef0c573d349e857ded201c680fd9c5f87085a11cb63f21262eb95f27b05e00d4eccf8197676b903502f8f7d94adfa666441
-  data.tar.gz: 27a270fd71d5deba222d85113231be86f43b747e538d11dcc404f459dd88e96a7d1dc26801a8af3ccf6a98a3ff906c55451d664fb964f56f05417730401aba63
+  metadata.gz: 3f19c42ebcad7d7d0f80788ab2509396d2a4602b7f7cb344b195124a702acdd12c37ded9986d09d003c54fd69d9ee1fa7784282e674c3149f28441cb6ddf8dca
+  data.tar.gz: 4f7d48105f283f95705e0d127a79739a7f625928762404c11d3374e23e6b316fb85e316cf3cdb222d5be2b0df462be9c9761ada9c0453d8a4311f36856ce30db

data/Gemfile

@@ -1,3 +1,10 @@
 source 'https://rubygems.org'
 gemspec
 
+logstash_path = ENV["LOGSTASH_PATH"] || "/usr/share/logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/lib/logstash/outputs/mqtt.rb

@@ -102,7 +102,11 @@ class LogStash::Outputs::MQTT < LogStash::Outputs::Base
   # Time in seconds to wait before retrying a connection
   config :connect_retry_interval, :validate => :number, :default => 10
 
-  public
+  # Time Keep alive connexion between ping to remote servers
+  config :keep_alive, :validate => :number, :default => 15
+
+
+
   def register
     @options = {
       :host => @host
@@ -131,6 +135,9 @@ class LogStash::Outputs::MQTT < LogStash::Outputs::Base
     if @ca_file
       @options[:ca_file] = @ca_file
     end
+    if @keep_alive
+      @options[:keep_alive] = @keep_alive
+    end
 
     # Encode events using the given codec
     # Use an array as a buffer so the multi_receive can handle multiple events with a single connection
@@ -138,50 +145,41 @@ class LogStash::Outputs::MQTT < LogStash::Outputs::Base
     @codec.on_event do |event, encoded_event|
       @event_buffer.push([event, encoded_event])
     end
-
   end # def register
 
-  public
   def receive(event)
-
     @codec.encode(event)
     handle_events
   end # def receive
 
-  public
   def multi_receive(events)
-    events.each do |event|
-      @codec.encode(event)
-    end
-
+    events.each { |event| @codec.encode(event) }
     # Handle all events at once to prevent taking a new connection for each event
     handle_events
   end
 
-  public
   def close
-
     @closing = true
   end # def close
 
   private
-  def handle_events
-    # Simple design: connect separately for each event / bunch of events in the buffer
-    # This way it is easy to cope with network failures, ie. if connection fails just try it again
+
+  def mqtt_client
     @logger.debug("Connecting MQTT with options #{@options}")
-    MQTT::Client.connect(@options) do |client|
-      while event = @event_buffer.first do
-        @logger.debug("Publishing MQTT event #{event[1]} with topic #{@topic}, retain #{@retain}, qos #{@qos}")
-        client.publish(event[0].sprintf(@topic), event[1], @retain, @qos)
-        @event_buffer.shift
-      end
-    end
+    @mqtt_client ||= MQTT::Client.connect(@options)
+  end
 
+  def handle_events
+    # It is easy to cope with network failures, ie. if connection fails just try it again
+    while event = @event_buffer.first do
+      @logger.debug("Publishing MQTT event #{event[1]} with topic #{@topic}, retain #{@retain}, qos #{@qos}")
+      mqtt_client.publish(event[0].sprintf(@topic), event[1], @retain, @qos)
+      @event_buffer.shift
+    end
   rescue StandardError => e
     @logger.error("Error #{e.message} while publishing to MQTT server. Will retry in #{@connect_retry_interval} seconds.")
-
+    @mqtt_client = nil
     Stud.stoppable_sleep(@connect_retry_interval, 1) { @closing }
     retry
   end # def handle_event
-
 end # class LogStash::Outputs::MQTT

data/logstash-output-mqtt.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-mqtt'
-  s.version         = "1.1.0"
-  s.licenses = ["Apache License (2.0)"]
+  s.version         = "1.2.1"
+  s.licenses = ["Apache-2.0"]
   s.summary = "This is Logstash output plugin for the http://mqtt.org/[MQTT] protocol"
   s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
   s.authors = ["Tommi Palomäki"]
@@ -19,8 +19,9 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency "logstash-codec-json"
   s.add_runtime_dependency "mqtt"
-  s.add_development_dependency "logstash-devutils", "< 1.3.5"
+
+  s.add_development_dependency "logstash-devutils"
 end

data/spec/outputs/mqtt_spec.rb

@@ -4,6 +4,7 @@ require "logstash/outputs/mqtt"
 require "logstash/codecs/json"
 require "logstash/event"
 require "time"
+require "json"
 
 describe LogStash::Outputs::MQTT do
   # Define a sample event and its JSON encoded form
@@ -11,48 +12,37 @@ describe LogStash::Outputs::MQTT do
   tstamp = Time.parse(datestring)
   tstamp_utc = tstamp.utc.iso8601(3)
   let(:sample_event) { LogStash::Event.new("message" => "test message", "@timestamp" => datestring) }
-  encoded_event = "{\"@timestamp\":\"" + tstamp_utc + "\",\"@version\":\"1\",\"message\":\"test message\"}"
+  encoded_event = "{\"message\":\"test message\",\"@version\":\"1\",\"@timestamp\":\"" + tstamp_utc + "\"}"
 
   settings = {
     "host" => "test.mosquitto.org",
     "topic" => "hello"
   }
   let(:output) { LogStash::Outputs::MQTT.new(settings) }
-  let(:stub_client) { Object.new }
+  let(:stub_client) { instance_double(MQTT::Client) }
 
   before do
     output.register
   end
 
   describe "receive message" do
-
     it "connects and publishes with correct arguments" do
-
       expect(MQTT::Client).to receive(:connect).with(
         :host => "test.mosquitto.org",
         :port => 8883
-      ) do |*args, &block|
-        block.call(stub_client)
-      end
-
+      ).and_return(stub_client)
       expect(stub_client).to receive(:publish).with("hello", encoded_event, false, 0)
-
       output.receive(sample_event)
     end
   end
 
   describe "multi_receive" do
     it "connects once and publishes all messages" do
-
       expect(MQTT::Client).to receive(:connect).once.with(
         :host => "test.mosquitto.org",
         :port => 8883
-      ) do |*args, &block|
-        block.call(stub_client)
-      end
-
+      ).and_return(stub_client)
       expect(stub_client).to receive(:publish).exactly(3).times.with("hello", encoded_event, false, 0)
-
       three_events = [sample_event, sample_event, sample_event]
       output.multi_receive(three_events)
     end
@@ -65,14 +55,14 @@ describe "Test subtopic:" do
   tstamp = Time.parse(datestring)
   tstamp_utc = tstamp.utc.iso8601(3)
   let(:sample_event) { LogStash::Event.new("message" => "test message", "@timestamp" => datestring, "subtopic" => "mysubtopic") }
-  encoded_event = "{\"@timestamp\":\"" + tstamp_utc + "\",\"@version\":\"1\",\"message\":\"test message\",\"subtopic\":\"mysubtopic\"}"
+  encoded_event = "{\"@version\":\"1\",\"@timestamp\":\"" + tstamp_utc + "\",\"message\":\"test message\",\"subtopic\":\"mysubtopic\"}"
 
   settings = {
     "host" => "test.mosquitto.org",
     "topic" => "hello/%{subtopic}"
   }
   let(:output) { LogStash::Outputs::MQTT.new(settings) }
-  let(:stub_client) { Object.new }
+  let(:stub_client) { instance_double(MQTT::Client) }
 
   before do
     output.register
@@ -80,16 +70,11 @@ describe "Test subtopic:" do
 
   describe "receive message on a subtopic based on a field of an event" do
     it "connects and publishes" do
-
       expect(MQTT::Client).to receive(:connect).with(
         :host => "test.mosquitto.org",
         :port => 8883
-      ) do |*args, &block|
-        block.call(stub_client)
-      end
-
+      ).and_return(stub_client)
       expect(stub_client).to receive(:publish).with("hello/mysubtopic", encoded_event, false, 0)
-
       output.receive(sample_event)
     end
   end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Tommi Palomäki
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.99'
   name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -31,8 +37,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-json
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,8 +51,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: mqtt
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -55,17 +61,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '0'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the
   Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
   a stand-alone program
@@ -85,7 +91,7 @@ files:
 - spec/outputs/mqtt_spec.rb
 homepage: https://github.com/kompa3/logstash-output-mqtt
 licenses:
-- Apache License (2.0)
+- Apache-2.0
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
@@ -104,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: This is Logstash output plugin for the http://mqtt.org/[MQTT] protocol