logstash-output-azure_service_bus 0.1.6 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86afcaf954af103be089a59d6fecb8f6fe4f2d69b5190f7ffd6ad33648a46054
-  data.tar.gz: 29e8e7fa58b69b713df750609609a96e4a4f0d2000f37362cae92d20a36104ad
+  metadata.gz: d92fdd5d7f0480de294337224352219cbf9d3d716f52af0ab4e80ce9a15cda76
+  data.tar.gz: f71204c35cdb3ec8d8366e21c2a6704e267d2385084e40e55786f3159bb885f0
 SHA512:
-  metadata.gz: 242299e9ab1b5bc4ca4adb3af61976d05fe5216331a82b91dad00e19099187faeb0b90daa870b987a404ddbc50af18c13c44344a7adea648f83d967dd1431d64
-  data.tar.gz: 31fca87e475ae0e52ff5654f88b59f9a5efa84c739425938c853b4691f50b3ed241306bb7ec249f1e240571b55293a2fd7ee40301043f01d807b112a16057961
+  metadata.gz: cb50873e64d439fc6114e748c9fd86c53b70b6d7ca3ca3eb271c71950941ccaa92fc2927259e8143c2349bd32b2f56313ec1a257dc3bfc01a07afcfc55375efb
+  data.tar.gz: 5fd4b7d91de58c9e439cbf39f4d935a6f688b149ace2b0135743f3a1ed6684951828689066a73f447fa8a15f928cdd3c0affa1b02e9a5f5920b31edf9f6dd0e5

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,23 +10,24 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
 
   config :service_bus_namespace, :validate => :string, :required => true
   config :service_bus_entity, :validate => :string, :required => true
+  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.error("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',
       params: { 'api-version' => '2018-02-01', 'resource' => 'https://servicebus.azure.net/' },
       headers: { 'Metadata' => 'true' },
-      request: { timeout: 1 }
+      request: { timeout: 4 }
     ) do |f|
       f.request :retry, retry_options
     end
@@ -48,18 +49,26 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
   def send_events(events)
     messages = []
     events.each do |event|
-      messages.append({ 'Body' => JSON.generate(event.to_hash), 'BrokerProperties' => { 'ContentType' => 'application/json' } })
+      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(@messageid_field) } })
+      end
     end
     post_messages(messages)
   end
 
   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
-    raise "Error while sending message to Service Bus: HTTP #{response.status}" if response.status != 201
+    @logger.error("HTTP 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

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.1.6'
+  s.version       = '0.2.2'
   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.1.6
+  version: 0.2.2
 platform: ruby
 authors:
 - Harrison Golden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement