logstash-output-azure_service_bus 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a012e033e589d0cbb282efdfd74f9e080c633f94fd6258d996045773692c62b
-  data.tar.gz: 7fc41f8046108330b67aeaa3362e887cc687613f7af3a94fcd9ba88a232dd1b7
+  metadata.gz: a67fa04bdae51dece5761e74a988a0ebe3650bb9ef0bdf3e2865d13a7d978e9a
+  data.tar.gz: 5e81d65989042929f02f2500af06d50a816f7507b2acd83fa89ffddff553af8c
 SHA512:
-  metadata.gz: 28f07e9366427d46ae888feb53197e498f238866b689512b28f96b219cd3a270ac49ecbb4c74a19b7133164f567e930b5637318f30c53f4a269f4c4c0f000dd8
-  data.tar.gz: 4ed63e5f4b973a16bd04ca1da41ff6a3a30dacb70648dda8158582968632770c12a1afc068015bc1a65cd9fb3d975407c3500a9e74081b50c4122471d08a6524
+  metadata.gz: edec37ad077bc312121e37d2fca8820c910af1c2a73c0dc44dc943be699e08267b155fc5cf5351aa7732e49a72604cee66ec6b6a4b25904c71b17aa7c19db490
+  data.tar.gz: 46662ca942a33c7f19d80cf05a895ad3f729dd41970868703f5ee701b8c8bc9940642c486be64f5296771247ddd2e527c257227af9aeee6dc52b8ea17f626cf9

data/README.md

@@ -1,86 +1,27 @@
 # logstash-output-azure_service_bus
 
-This is a plugin for [Logstash](https://github.com/elastic/logstash).
+This plugin allows you to stream events from [Logstash](https://github.com/elastic/logstash) to a topic or queue in [Azure Service Bus](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview). Currently, the only supported authentication mechanism is using [managed identities](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) which means this plugin must be run in an Azure compute environment. The entire Logstash event (not just the message) is passed to Service Bus with a content type of `application/json`.
 
-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.
+This plugin is hosted on RubyGems.org: [https://rubygems.org/gems/logstash-output-azure_service_bus](https://rubygems.org/gems/logstash-output-azure_service_bus)
 
-## 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
+## Install
+To install, use the plugin tool that is part of your Logstash installation:
 ```
-
-- Run tests
-
-```sh
-bundle exec rspec
+$LOGSTASH_INSTALL/bin/logstash-plugin install logstash-output-azure_service_bus
 ```
 
-### 2. Running your unpublished Plugin in Logstash
+## Pipeline Configuration
+As mentioned above, the compute environment that Logstash is running in must have managed identity enabled. In addition, the managed identity should have permissions to send to the desired queue or topic - typically the `Azure Service Bus Data Sender` role.
 
-#### 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
+Two settings in your Logstash pipeline are required:
 ```
-- Run Logstash with your plugin
-```sh
-bin/logstash -e 'filter {awesome {}}'
+output {
+    azure_service_bus {
+        service_bus_namespace => "service-bus-name"
+        service_bus_entity => "queue-or-topic-name"
+    }
+}
 ```
-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.
+## Service Bus Configuration
+This plugin will retry sending messages if the Service Bus connection times out or returns a bad response. To avoid idempotence issues, you should enable duplicate detection on the destination queue or topic.

data/lib/logstash/outputs/azure_service_bus.rb

@@ -3,7 +3,6 @@ require 'faraday/retry'
 require 'json'
 require 'logstash/outputs/base'
 
-# An azure_service_bus output that does nothing.
 class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
   concurrency :single
 
@@ -14,12 +13,14 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
 
   def register
     retry_options = {
-      max: 3,
+      max: 5,
       interval: 1,
       interval_randomness: 0.5,
-      backoff_factor: 2,
+      backoff_factor: 3,
       retry_statuses: [429, 500],
-      exceptions: [Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::RetriableResponse, Net::ReadTimeout]
+      exceptions: [Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::RetriableResponse],
+      methods: %i[get post],
+      retry_block: ->(_env, _options, retries, exception) { @logger.error("Error (#{exception}) for #{env.method.upcase} #{env.url} - #{retries + 1} retry(s) left") }
     }
     @token_conn = Faraday.new(
       url: 'http://169.254.169.254/metadata/identity/oauth2/token',
@@ -31,7 +32,7 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
     end
     @service_bus_conn = Faraday.new(
       url: "https://#{@service_bus_namespace}.servicebus.windows.net/#{@service_bus_entity}/",
-      request: { timeout: 1 }
+      request: { timeout: 3 }
     ) do |f|
       f.request :retry, retry_options
     end
@@ -58,9 +59,9 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
       req.body = JSON.generate(messages)
       req.headers = { 'Authorization' => "Bearer #{@access_token}", 'Content-Type' => 'application/vnd.microsoft.servicebus.json' }
     end
-    raise "Error while sending message to Service Bus: #{response.body}" if response.status != 201
+    raise "Error while sending message to Service Bus: HTTP #{response.status}" if response.status != 201
 
-    @logger.info("Sent #{messages.length} message(s) to Service Bus")
+    @logger.debug("Sent #{messages.length} message(s) to Service Bus")
   end
 
   def access_token_needs_refresh?

data/logstash-output-azure_service_bus.gemspec

@@ -1,12 +1,13 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-azure_service_bus'
-  s.version       = '0.1.0'
+  s.version       = '0.1.4'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Send Logstash messages to Azure Service Bus.'
   s.homepage      = 'https://github.com/gharryg/logstash-output-azure_service_bus'
   s.authors       = ['Harrison Golden']
   s.email         = 'gharryg@mac.com'
   s.require_paths = ['lib']
+  s.required_ruby_version = '>=2.5.0'
 
   # Files
   s.files = Dir['lib/**/*', '*.gemspec', '*.md', 'Gemfile', 'LICENSE']
@@ -15,9 +16,8 @@ Gem::Specification.new do |s|
   s.metadata = { 'logstash_plugin' => 'true', 'logstash_group' => 'output' }
 
   # Gem dependencies
-  s.add_runtime_dependency 'faraday'
-  s.add_runtime_dependency 'faraday-retry'
+  s.add_runtime_dependency 'faraday', '~> 1.9'
+  s.add_runtime_dependency 'faraday-retry', '~> 1.0'
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency 'logstash-core-plugin-api'
-  s.add_development_dependency 'logstash-devutils'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-azure_service_bus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Harrison Golden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   name: faraday
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   name: faraday-retry
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !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
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email: gharryg@mac.com
 executables: []
@@ -105,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="