logstash-output-azure_service_bus 0.2.3 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d25bb98310be24692a94d2fcd87e0e5845957f42c16b923b2e9fcf381275bb1b
-  data.tar.gz: 514c75f9918c1e17d659d6781ed2a50b2caf28ed9a8f96a0c326d42894794116
+  metadata.gz: '083f7b36cee46fdb059036aaf5d1be5147d9847698668ccd47d2d55e2178726b'
+  data.tar.gz: 83a758c5fec612555dcd2bbd019ce6cc8fc6a387d0d0203b1f5af8bc8316ffd8
 SHA512:
-  metadata.gz: 3d547ae59c36e62cf3da4b1919b5a5a6932fccd5132775b6762d02954533b128592b328be7376b78ba64b2aef0dd5039ab82b296f5a2986c0b3afec9494eb00b
-  data.tar.gz: 436eb44572d7ed0d5b4127a142c810f5c5307f33f47a0022c448b578d64e4f0a435e5954f2f0ee3363e9a0777a7ab587dac9e0d975e04cfe3a7f7f14fb436613
+  metadata.gz: 0be573d501e76e02a9ccc60fdbdaf79cde4550e9e0930ba6bfed8ace0721f9a659c176720ecacc6774bb27c80ae2329f1adadc10af2e476bb747f8b11f47bb64
+  data.tar.gz: 5de0f339d87b98804a369638051134c854d4860f9eb9d87d8a616ada52609cadad91edd89012562c9f64dfe111a3aa839214f5ecb575a63100ca611d05d1779e

data/README.md

@@ -43,5 +43,5 @@ output {
 }
 ```
 
-## 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.
+## Retry
+This plugin will retry sending messages _indefinitely_ if Service Bus times out or returns a [documented bad response](https://docs.microsoft.com/en-us/rest/api/servicebus/send-message-batch#response-codes) (except 400). To avoid idempotence issues, you should enable duplicate detection on the destination queue or topic.

data/lib/logstash/outputs/azure_service_bus.rb

@@ -13,30 +13,33 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
   config :messageid_field, :validate => :string
 
   def register
-    retry_options = {
-      max: 5,
+    service_bus_retry_options = {
+      max: Float::MAX, # Essentially retries indefinitely
       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("Problem (#{exception}) for #{env.method.upcase} #{env.url} - #{retries + 1} retry(s) left") }
+      exceptions: [Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::RetriableResponse, Errno::ECONNRESET],
+      methods: [], # Empty -> all methods
+      retry_statuses: [401, 403, 404, 410, 429, 500], # https://docs.microsoft.com/en-us/rest/api/servicebus/send-message-batch#response-codes
+      retry_block: lambda do |env, _options, _retries, exception|
+        if env.status.nil?
+          @logger.warn("Problem (#{exception}) for #{env.method.upcase} #{env.url}")
+        else
+          @logger.warn("Problem (HTTP #{env.status}) for #{env.method.upcase} #{env.url}")
+        end
+      end,
+      retry_if: lambda do |env, _exc|
+        refresh_access_token if env.status == 401
+        true # Always retry
+      end
     }
-    @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: 4 }
-    ) do |f|
-      f.request :retry, retry_options
-    end
     @service_bus_conn = Faraday.new(
       url: "https://#{@service_bus_namespace}.servicebus.windows.net/#{@service_bus_entity}/",
       request: { timeout: 10 }
-    ) do |f|
-      f.request :retry, retry_options
+    ) do |conn|
+      conn.request :retry, service_bus_retry_options
     end
+    @access_token = ''
     refresh_access_token
   end
 
@@ -59,37 +62,37 @@ class LogStash::Outputs::AzureServiceBus < LogStash::Outputs::Base
   end
 
   def post_messages(messages)
-    refresh_access_token if access_token_needs_refresh?
-    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")
+    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
-    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
+  rescue StandardError => e
+    # Hopefully we never make it here and "throw away" messages since we have an agressive retry strategy.
+    @logger.error("Error (#{e}) while sending message to Service Bus")
+  else
+    if response.status == 200
+      @logger.debug("Sent #{messages.length} message(s) to Service Bus")
+    else
+      @logger.error("Error while sending message to Service Bus: HTTP #{response.status}")
     end
   end
 
-  def access_token_needs_refresh?
-    Time.now.to_i - 60 > @access_token_expiration # Refresh the access token if it will expire within 60 seconds.
-  end
-
   def refresh_access_token
     @logger.info('Refreshing Azure access token')
     begin
-      response = @token_conn.get
-    rescue Faraday::ConnectionFailed => e
-      @logger.error('Unable to connect to the Azure Instance Metadata Service')
-      raise e
+      response = Faraday.get('http://169.254.169.254/metadata/identity/oauth2/token', { 'api-version' => '2018-02-01', 'resource' => 'https://servicebus.azure.net/' }) do |req|
+        req.headers = { 'Metadata' => 'true' }
+        req.options.timeout = 4
+      end
+    rescue StandardError => e # We just catch everything and move on since @service_bus_conn will handle retries.
+      @logger.error("Error while fetching access token: #{e}")
+    else
+      if response.status == 200
+        data = JSON.parse(response.body)
+        @access_token = data['access_token']
+      else
+        @logger.error("HTTP error when fetching access token: #{response.body}")
+      end
     end
-    raise "Unable to fetch token: #{response.body}" if response.status != 200
-
-    data = JSON.parse(response.body)
-    @access_token = data['access_token']
-    @access_token_expiration = data['expires_on'].to_i
   end
 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.2.3'
+  s.version       = '0.3.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.2.3
+  version: 0.3.2
 platform: ruby
 authors:
 - Harrison Golden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement