logstash-output-azure_service_bus 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 016441e1bf597f2bdea94a9123cf4a5fb10541ee6181455bb070a623cd0d1b74
-  data.tar.gz: 872320c9b33b392745ddd08781bbd3f6bb14516150808d9f79079ead73bd5fea
+  metadata.gz: d25bb98310be24692a94d2fcd87e0e5845957f42c16b923b2e9fcf381275bb1b
+  data.tar.gz: 514c75f9918c1e17d659d6781ed2a50b2caf28ed9a8f96a0c326d42894794116
 SHA512:
-  metadata.gz: a69069641020d293436f0a6b9bb633734b030fc16731a006ab54deabc5e42958fbcae23c13aa370c200b51fbb8af7fe7c47f98256a9bb051fbf07a7438cd724a
-  data.tar.gz: 9ced162d4a22745c9507c2e38800f493a04f9cb938d63ba3fcde836d5d997f9774f3eeaa28caf7c38f4fb11c22a8f15a77ae8be73d54feecf5928bd778afa43c
+  metadata.gz: 3d547ae59c36e62cf3da4b1919b5a5a6932fccd5132775b6762d02954533b128592b328be7376b78ba64b2aef0dd5039ab82b296f5a2986c0b3afec9494eb00b
+  data.tar.gz: 436eb44572d7ed0d5b4127a142c810f5c5307f33f47a0022c448b578d64e4f0a435e5954f2f0ee3363e9a0777a7ab587dac9e0d975e04cfe3a7f7f14fb436613

data/README.md

@@ -7,7 +7,7 @@ This plugin is hosted on RubyGems.org: [https://rubygems.org/gems/logstash-outpu
 ## Install
 To install, use the plugin tool that is part of your Logstash installation:
 ```
-$LOGSTASH_INSTALL/bin/logstash-plugin install logstash-output-azure_service_bus
+$LOGSTASH_PATH/bin/logstash-plugin install logstash-output-azure_service_bus
 ```
 
 ## Pipeline Configuration
@@ -22,6 +22,26 @@ output {
     }
 }
 ```
+There is one optional setting (`messageid_field`) which sets the Service Bus `MessageId` value to an existing, unique field. If this setting is not used, Service Bus will generate an id when the message is created.  The value of the provided field _must_ be unique or Service Bus will reject the message. A sample config might look like:
+```
+input { ... }
+filter {
+    uuid {
+        target => "[@metadata][uuid]"
+    }
+}
+output {
+    azure_service_bus {
+        service_bus_namespace => "service-bus-name"
+        service_bus_entity => "queue-or-topic-name"
+        messageid_field => "[@metadata][uuid]"
+    }
+    elasticsearch {
+        ...
+        document_id => "%{[@metadata][uuid]}"
+    }
+}
+```
 
 ## 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

@@ -10,18 +10,18 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
 
   config :service_bus_namespace, :validate => :string, :required => true
   config :service_bus_entity, :validate => :string, :required => true
-  config :uuid_field, :validate => :string
+  config :messageid_field, :validate => :string
 
   def register
     retry_options = {
-      max: 3,
+      max: 5,
       interval: 1,
       interval_randomness: 0.5,
       backoff_factor: 2,
       retry_statuses: [429, 500],
       exceptions: [Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::RetriableResponse],
       methods: %i[get post],
-      retry_block: ->(env, _options, retries, exception) { @logger.warn("Error (#{exception}) for #{env.method.upcase} #{env.url} - #{retries + 1} retry(s) left") }
+      retry_block: ->(env, _options, retries, exception) { @logger.warn("Problem (#{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',
@@ -49,10 +49,10 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
   def send_events(events)
     messages = []
     events.each do |event|
-      if @uuid_field.nil?
+      if @messageid_field.nil?
         messages.append({ 'Body' => JSON.generate(event.to_hash), 'BrokerProperties' => { 'ContentType' => 'application/json' } })
       else
-        messages.append({ 'Body' => JSON.generate(event.to_hash), 'BrokerProperties' => { 'ContentType' => 'application/json', 'MessageId' => event.get(@uuid_field) } })
+        messages.append({ 'Body' => JSON.generate(event.to_hash), 'BrokerProperties' => { 'ContentType' => 'application/json', 'MessageId' => event.get(@messageid_field) } })
       end
     end
     post_messages(messages)
@@ -60,13 +60,18 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
 
   def post_messages(messages)
     refresh_access_token if access_token_needs_refresh?
-    response = @service_bus_conn.post('messages') do |req|
-      req.body = JSON.generate(messages)
-      req.headers = { 'Authorization' => "Bearer #{@access_token}", 'Content-Type' => 'application/vnd.microsoft.servicebus.json' }
+    begin
+      response = @service_bus_conn.post('messages') do |req|
+        req.body = JSON.generate(messages)
+        req.headers = { 'Authorization' => "Bearer #{@access_token}", 'Content-Type' => 'application/vnd.microsoft.servicebus.json' }
+      end
+    rescue StandardError => e
+      @logger.error("Error (#{e}) while sending message to Service Bus")
+    end
+    if !response.nil?
+      @logger.error("Error while sending message to Service Bus: HTTP #{response.status}") if response.status != 201
+      @logger.debug("Sent #{messages.length} message(s) to Service Bus") if response.status == 200
     end
-    raise "Error while sending message to Service Bus: HTTP #{response.status}" if response.status != 201
-
-    @logger.debug("Sent #{messages.length} message(s) to Service Bus")
   end
 
   def access_token_needs_refresh?

data/logstash-output-azure_service_bus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-azure_service_bus'
-  s.version       = '0.2.0'
+  s.version       = '0.2.3'
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-azure_service_bus
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Harrison Golden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement