logstash-output-mqtt2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72cf08e5cf11cf8a9d3a50c7742f2fc9100675228cec24130b696d9a6a51f9bc
+  data.tar.gz: 92090082b0aa43f1a09ced91cf87df83b1ac9f71bb9eace96661e0dda948b9bd
+SHA512:
+  metadata.gz: aa035bf08e1208ae928bd5e9387227e841f2accbedc0d7e597c6da3afc188e9cad8b96d67ea5589775696ac2d2be28c959a6d3368b71b70d0ee188e804f13c97
+  data.tar.gz: 3598c8d057db24716c978ab1b18cc2e3ceccba6d7f38b907c530ff3da53fca6839b18d90ace7f20020693e44fd890a290342e6e78500bcb286811bbf1fb5e8a4

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+*  - 
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-mqtt2
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,11 @@
+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,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/mqtt2.rb

@@ -0,0 +1,184 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "mqtt"
+
+# This is Logstash output plugin for the http://mqtt.org/[MQTT] protocol.
+#
+# Features:
+#
+# * Publish messages to a topic
+# * TSL/SSL connection to MQTT server (optional)
+# * Message publishing to a topic
+# * QoS levels 0 and 1 (note that QoS 2 is not currently supported due to https://github.com/njh/ruby-mqtt[ruby-mqtt] library limitations)
+# * Fault tolerance for network shortages, however not optimzied for performance since it takes a new connection for each event (or a bunch of events) to be published
+# * MQTT protocol version 3.1.0
+#
+# Example publishing to test.mosquitto.org:
+# [source,ruby]
+# ----------------------------------
+# output {
+#   mqtt {
+#     host => "test.mosquitto.org"
+#     port => 8883
+#     topic => "hello"
+#   }
+# }
+# ----------------------------------
+#
+# Example publishing to https://aws.amazon.com/iot/[AWS IoT]:
+# [source,ruby]
+# ----------------------------------
+# output {
+#   mqtt {
+#     host => "somehostname.iot.someregion.amazonaws.com"
+#     port => 8883
+#     topic => "hello"
+#     client_id => "clientidfromaws"
+#     ssl => true
+#     cert_file => "certificate.pem.crt"
+#     key_file => "private.pem.key"
+#     ca_file => "root-CA.crt"
+#   }
+# }
+# ----------------------------------
+#
+# 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
+
+  config_name "mqtt2"
+
+  # The default codec for this plugin is JSON. You can override this to suit your particular needs however.
+  default :codec, "json"
+
+  # MQTT server host name
+  config :host, :validate => :string, :required => true
+
+  # Port to connect to
+  config :port, :validate => :number, :default => 8883
+
+  # Topic that the messages will be published to
+  config :topic, :validate => :string, :required => true
+
+  # Retain flag of the published message
+  # If true, the message will be stored by the server and be sent immediately to each subscribing client
+  # so that the subscribing client doesn't have to wait until a publishing client sends the next update
+  config :retain, :validate => :boolean, :default => false
+
+  # QoS of the published message, can be either 0 (at most once) or 1 (at least once)
+  config :qos, :validate => :number, :default => 0
+
+  # Client identifier (generated automatically if not given)
+  config :client_id, :validate => :string
+
+  # Username to authenticate to the server with
+  config :username, :validate => :string
+
+  # Password to authenticate to the server with
+  config :password, :validate => :string
+
+  # Set to true to enable SSL/TLS encrypted communication
+  config :ssl, :validate => :boolean, :default => false
+
+  # Client certificate file used to SSL/TLS communication
+  config :cert_file, :validate => :path
+
+  # Private key file associated with the client certificate
+  config :key_file, :validate => :path
+
+  # Root CA certificate
+  config :ca_file, :validate => :path
+
+  # Time in seconds to wait before retrying a connection
+  config :connect_retry_interval, :validate => :number, :default => 10
+
+  # Time Keep alive connexion between ping to remote servers
+  config :keep_alive, :validate => :number, :default => 15
+
+
+  public
+  def register
+    @options = {
+      :host => @host
+    }
+    if @port
+      @options[:port] = @port
+    end
+    if @client_id
+      @options[:client_id] = @client_id
+    end
+    if @username
+      @options[:username] = @username
+    end
+    if @password
+      @options[:password] = @password
+    end
+    if @ssl
+      @options[:ssl] = @ssl
+    end
+    if @cert_file
+      @options[:cert_file] = @cert_file
+    end
+    if @key_file
+      @options[:key_file] = @key_file
+    end
+    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
+    @event_buffer = Array.new
+    @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
+
+  def multi_receive(events)
+    events.each { |event| @codec.encode(event) }
+    # Handle all events at once to prevent taking a new connection for each event
+    handle_events
+  end
+
+  def close
+    @closing = true
+  end # def close
+
+  private
+
+  def mqtt_client
+    @logger.debug("Connecting MQTT with options #{@options}")
+    @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::MQTT2

data/logstash-output-mqtt2.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = "logstash-output-mqtt2"
+  s.version       = "1.0.0"
+  s.license       = "Apache-2.0"
+  s.summary       = "Logstash MQTT OUTPUT"
+  s.description   = "Logstash MQTT OUTPUT to manage real time actions"
+  s.homepage      = "https://github.com/hupiv/logstash-output-mqtt2"
+  s.authors       = ["HUPI - Vincent Moreno"]
+  s.email         = "contact@hupi.fr"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  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-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/mqtt2_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/mqtt2"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Mqtt2 do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Mqtt2.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-mqtt2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- HUPI - Vincent Moreno
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  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'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  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: Logstash MQTT OUTPUT to manage real time actions
+email: contact@hupi.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/mqtt2.rb
+- logstash-output-mqtt2.gemspec
+- spec/outputs/mqtt2_spec.rb
+homepage: https://github.com/hupiv/logstash-output-mqtt2
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Logstash MQTT OUTPUT
+test_files:
+- spec/outputs/mqtt2_spec.rb