logstash-output-mqtt 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17013b01e741f72e3f02d5c3a10593eeef722fd3
-  data.tar.gz: 671cfaa6cfdb3f8439024e67be40e36a7e3e638c
+  metadata.gz: 3dcc117ed489aa6aa8ae774a3d300f9df65b153b
+  data.tar.gz: 54f322258c1d332cbdf8e64a07d506cbb2abbeaf
 SHA512:
-  metadata.gz: ebd202f9302921cf5c4586093e51b6aa90413abb13f6d414fa9b1e20535333523b8fa67827a896ba67dea491a5feb4e5253a8a952c0926218b41d036d9ef9373
-  data.tar.gz: 41599ded9be3f55f788af0dccf0bcfb1eb0d59ef939df61e0815b87b7fb55b87551a1a4c716f2f8a0617482253282eadf75579c743cfe143eb4e9ad7daf5dd3e
+  metadata.gz: 4d6baf3c028c4a729a2baa094099729ee54acdb133c5040dc5ad8b664e8c6326c5ea0b1eb5ccb77a1a403823ae67f7065feaa67196000e080b9708632ff3198b
+  data.tar.gz: df91c4d1db2ba435611aa3b801bad8a42c49b9452bd5b71aa8a9f28c48bd593f65c6fc5ca26a80125d257ec37c2ba23b4e3b2628d456eaf8019e1b73de4010d1

data/lib/logstash/outputs/mqtt.rb

@@ -43,8 +43,16 @@ require "mqtt"
 # }
 # ----------------------------------
 #
-# Note that you will obtain the above configuration items when connecting a device in AWS IoT service.
-# The root CA certificate is also available from Symantec https://www.symantec.com/content/en/us/enterprise/verisign/roots/VeriSign-Class%203-Public-Primary-Certification-Authority-G5.pem[here].
+# Topic may also depend on parts of the event using the standard sprintf syntax.
+# [source,ruby]
+# ----------------------------------
+# output {
+#   mqtt {
+#     ...
+#     topic => "something/%{myfield}"
+#   }
+# }
+# ----------------------------------
 
 class LogStash::Outputs::MQTT < LogStash::Outputs::Base
 
@@ -128,7 +136,7 @@ class LogStash::Outputs::MQTT < LogStash::Outputs::Base
     # Use an array as a buffer so the multi_receive can handle multiple events with a single connection
     @event_buffer = Array.new
     @codec.on_event do |event, encoded_event|
-      @event_buffer.push(encoded_event)
+      @event_buffer.push([event, encoded_event])
     end
 
   end # def register
@@ -162,9 +170,9 @@ class LogStash::Outputs::MQTT < LogStash::Outputs::Base
     # This way it is easy to cope with network failures, ie. if connection fails just try it again
     @logger.debug("Connecting MQTT with options #{@options}")
     MQTT::Client.connect(@options) do |client|
-      while encoded_event = @event_buffer.first do
-        @logger.debug("Publishing MQTT event #{encoded_event} with topic #{@topic}, retain #{@retain}, qos #{@qos}")
-        client.publish(@topic, encoded_event, @retain, @qos)
+      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

data/logstash-output-mqtt.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-mqtt'
-  s.version         = "0.9.0"
+  s.version         = "0.9.1"
   s.licenses = ["Apache License (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"

data/spec/outputs/mqtt_spec.rb

@@ -3,11 +3,15 @@ require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/mqtt"
 require "logstash/codecs/json"
 require "logstash/event"
+require "time"
 
 describe LogStash::Outputs::MQTT do
   # Define a sample event and its JSON encoded form
-  let(:sample_event) { LogStash::Event.new("message" => "test message", "@timestamp" => "2016-01-01") }
-  encoded_event = "{\"message\":\"test message\",\"@timestamp\":\"2016-01-01T00:00:00.000Z\",\"@version\":\"1\"}"
+  datestring = "2016-01-01"
+  tstamp = Time.parse(datestring)
+  tstamp_utc = tstamp.utc.iso8601(3)
+  let(:sample_event) { LogStash::Event.new("message" => "test message", "@timestamp" => datestring) }
+  encoded_event = "{\"message\":\"test message\",\"@timestamp\":\"" + tstamp_utc + "\",\"@version\":\"1\"}"
 
   settings = {
     "host" => "test.mosquitto.org",
@@ -54,3 +58,40 @@ describe LogStash::Outputs::MQTT do
     end
   end
 end
+
+describe "Test subtopic:" do
+  # Define a sample event and its JSON encoded form
+  datestring = "2016-01-01"
+  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 = "{\"message\":\"test message\",\"@timestamp\":\"" + tstamp_utc + "\",\"subtopic\":\"mysubtopic\",\"@version\":\"1\"}"
+
+  settings = {
+    "host" => "test.mosquitto.org",
+    "topic" => "hello/%{subtopic}"
+  }
+  let(:output) { LogStash::Outputs::MQTT.new(settings) }
+  let(:stub_client) { Object.new }
+
+  before do
+    output.register
+  end
+
+  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
+
+      expect(stub_client).to receive(:publish).with("hello/mysubtopic", encoded_event, false, 0)
+
+      output.receive(sample_event)
+    end
+  end
+
+end

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-mqtt
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
   name: logstash-core
@@ -24,16 +24,16 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-json
@@ -41,13 +41,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: mqtt
@@ -55,13 +55,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
@@ -69,7 +69,7 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         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
@@ -98,17 +98,17 @@ 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.4.8
+rubygems_version: 2.6.6
 signing_key:
 specification_version: 4
 summary: This is Logstash output plugin for the http://mqtt.org/[MQTT] protocol