sentinelblue-logstash-output-azure-loganalytics 1.1.2.rc1 → 1.1.3.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba5af5f1a409d3a92195e04621db3b1a94e3d316b195cd2cd22f5e8d932cc6c
-  data.tar.gz: 01fc4bc23a6e33f8ab04aeb574dd529bd22064e8b5577f27ce9dc8e548d5f103
+  metadata.gz: 8a6135d1df0d5d38a762d443acea323b7cca725c3a381a4782137e5da06c1830
+  data.tar.gz: 74141b9a0d28b93e623e1da575243ea94ffdf2f2baf4527102ff5e21297fc643
 SHA512:
-  metadata.gz: 97f2e8591b4af40cb2bb76f20be0a847d1e10d3ed005c683293a26e1b681b224e1a50d8c604266a0816afec46af81b1283251312ccc37ef33fdb6814af64864f
-  data.tar.gz: 57bbb6ca200bfd4af2d1f1049585540c4eec5c10957f3ff48a489db46c3a352849aa5369ee402ec35d4958550ef0608a842e141e7139d3775b92981ba11f652a
+  metadata.gz: a0142efda4fff94c1bc7a46865674c27cf68e23b46e32789257c4b4bb686f574bc8397adb7da3a54861b6dc70c1b87eea3e5b9a4abf3ec20a7db567fefb58a45
+  data.tar.gz: 0b8f6ca5ba27907346cd8fe31a9965e4e301ae0772324fb2407fb1434ac0ad26b9afee5838320bcfd7ee167b667ef43a398693ca9e125438406476b77bf4cbd9

data/CHANGELOG.md

@@ -5,3 +5,11 @@
 ## 1.1.1
 
 * Updated strings to reference Sentinel Blue
+
+## 1.1.2
+
+* Enhanced error checking 
+
+## 1.1.3
+
+* Renamed classes to avoid conflict with microsoft-logstash-output-azure-loganalytics plugin

data/VERSION

@@ -1 +1 @@
-1.1.2.rc1
+1.1.3.rc1

data/lib/logstash/{logAnalyticsClient/logAnalyticsClient.rb → azureLAClasses/azureLAClient.rb}

@@ -1,18 +1,18 @@
 # encoding: utf-8
-require "logstash/logAnalyticsClient/logstashLoganalyticsConfiguration"
+require "logstash/azureLAClasses/logAnalyticsConfiguration"
 require 'rest-client'
 require 'json'
 require 'openssl'
 require 'base64'
 require 'time'
 
-class LogAnalyticsClient
+class AzureLAClient
   API_VERSION = '2016-04-01'.freeze
 
-  def initialize (logstashLoganalyticsConfiguration)
-    @logstashLoganalyticsConfiguration = logstashLoganalyticsConfiguration
-    set_proxy(@logstashLoganalyticsConfiguration.proxy)
-    @uri = sprintf("https://%s.%s/api/logs?api-version=%s", @logstashLoganalyticsConfiguration.workspace_id, @logstashLoganalyticsConfiguration.endpoint, API_VERSION)
+  def initialize (logAnalyticsConfiguration)
+    @logAnalyticsConfiguration = logAnalyticsConfiguration
+    set_proxy(@logAnalyticsConfiguration.proxy)
+    @uri = sprintf("https://%s.%s/api/logs?api-version=%s", @logAnalyticsConfiguration.workspace_id, @logAnalyticsConfiguration.endpoint, API_VERSION)
   end # def initialize
 
 
@@ -39,8 +39,8 @@ class LogAnalyticsClient
       'Authorization' => signature(date, body_bytesize_length),
       'Log-Type' => custom_table_name,
       'x-ms-date' => date,
-      'time-generated-field' =>  @logstashLoganalyticsConfiguration.time_generated_field,
-      'x-ms-AzureResourceId' => @logstashLoganalyticsConfiguration.azure_resource_id
+      'time-generated-field' =>  @logAnalyticsConfiguration.time_generated_field,
+      'x-ms-AzureResourceId' => @logAnalyticsConfiguration.azure_resource_id
     }
   end # def get_header
 
@@ -61,10 +61,10 @@ class LogAnalyticsClient
   def signature(date, body_bytesize_length)
     sigs = sprintf("POST\n%d\napplication/json\nx-ms-date:%s\n/api/logs", body_bytesize_length, date)
     utf8_sigs = sigs.encode('utf-8')
-    decoded_shared_key = Base64.decode64(@logstashLoganalyticsConfiguration.workspace_key)
+    decoded_shared_key = Base64.decode64(@logAnalyticsConfiguration.workspace_key)
     hmac_sha256_sigs = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), decoded_shared_key, utf8_sigs)
     encoded_hash = Base64.encode64(hmac_sha256_sigs)
-    authorization = sprintf("SharedKey %s:%s", @logstashLoganalyticsConfiguration.workspace_id, encoded_hash)
+    authorization = sprintf("SharedKey %s:%s", @logAnalyticsConfiguration.workspace_id, encoded_hash)
     
     return authorization
   end # def signature

data/lib/logstash/{logAnalyticsClient/logStashAutoResizeBuffer.rb → azureLAClasses/logAnalyticsAutoResizeBuffer.rb}

@@ -1,23 +1,23 @@
 # encoding: utf-8
 require "stud/buffer"
-require "logstash/logAnalyticsClient/logAnalyticsClient"
+require "logstash/azureLAClasses/azureLAClient"
 require "stud/buffer"
-require "logstash/logAnalyticsClient/logstashLoganalyticsConfiguration"
+require "logstash/azureLAClasses/logAnalyticsConfiguration"
 
-# LogStashAutoResizeBuffer class setting a resizable buffer which is flushed periodically
+# LogAnalyticsAutoResizeBuffer class setting a resizable buffer which is flushed periodically
 # The buffer resize itself according to Azure Loganalytics  and configuration limitations
-class LogStashAutoResizeBuffer
+class LogAnalyticsAutoResizeBuffer
     include Stud::Buffer
 
-    def initialize(logstashLoganalyticsConfiguration,custom_table_name)
-        @logstashLoganalyticsConfiguration = logstashLoganalyticsConfiguration
-        @logger = @logstashLoganalyticsConfiguration.logger
+    def initialize(logAnalyticsConfiguration,custom_table_name)
+        @logAnalyticsConfiguration = logAnalyticsConfiguration
+        @logger = @logAnalyticsConfiguration.logger
         @custom_log_table_name = custom_table_name
-        @client=LogAnalyticsClient::new(logstashLoganalyticsConfiguration)
+        @client=AzureLAClient::new(logAnalyticsConfiguration)
         buffer_initialize(
-          :max_items => logstashLoganalyticsConfiguration.max_items,
-          :max_interval => logstashLoganalyticsConfiguration.plugin_flush_interval,
-          :logger => @logstashLoganalyticsConfiguration.logger
+          :max_items => logAnalyticsConfiguration.max_items,
+          :max_interval => logAnalyticsConfiguration.plugin_flush_interval,
+          :logger => @logAnalyticsConfiguration.logger
         )
     end # initialize
 
@@ -41,7 +41,7 @@ class LogStashAutoResizeBuffer
         # We send Json in the REST request 
         documents_json = documents.to_json
         # Setting resizing to true will cause changing the max size
-        if @logstashLoganalyticsConfiguration.amount_resizing == true
+        if @logAnalyticsConfiguration.amount_resizing == true
             # Resizing the amount of messages according to size of message received and amount of messages
             change_message_limit_size(documents.length, documents_json.bytesize)
         end
@@ -60,12 +60,12 @@ class LogStashAutoResizeBuffer
                 @logger.info("Successfully posted #{amount_of_documents} logs into custom log analytics table[#{@custom_log_table_name}].")
             else
                 @logger.error("DataCollector API request failure: error code: #{response.code}, data=>" + (documents.to_json).to_s)
-                resend_message(documents_json, amount_of_documents, @logstashLoganalyticsConfiguration.retransmission_time)
+                resend_message(documents_json, amount_of_documents, @logAnalyticsConfiguration.retransmission_time)
             end
             rescue Exception => ex
                 @logger.error("Exception in posting data to Azure Loganalytics. [Exception: '#{ex}]'")
                 @logger.trace("Exception in posting data to Azure Loganalytics.[amount_of_documents=#{amount_of_documents} documents=#{documents_json}]")
-                resend_message(documents_json, amount_of_documents, @logstashLoganalyticsConfiguration.retransmission_time)
+                resend_message(documents_json, amount_of_documents, @logAnalyticsConfiguration.retransmission_time)
             end
     end # end send_message_to_loganalytics
 
@@ -73,19 +73,19 @@ class LogStashAutoResizeBuffer
     # We would like to do it until we reached to the duration 
     def resend_message(documents_json, amount_of_documents, remaining_duration)
         if remaining_duration > 0
-            @logger.info("Resending #{amount_of_documents} documents as log type #{@custom_log_table_name} to DataCollector API in #{@logstashLoganalyticsConfiguration.RETRANSMISSION_DELAY} seconds.")
-            sleep @logstashLoganalyticsConfiguration.RETRANSMISSION_DELAY
+            @logger.info("Resending #{amount_of_documents} documents as log type #{@custom_log_table_name} to DataCollector API in #{@logAnalyticsConfiguration.RETRANSMISSION_DELAY} seconds.")
+            sleep @logAnalyticsConfiguration.RETRANSMISSION_DELAY
             begin
                 response = @client.post_data(documents_json,@custom_log_table_name)
                 if is_successfully_posted(response)
                     @logger.info("Successfully sent #{amount_of_documents} logs into custom log analytics table[#{@custom_log_table_name}] after resending.")
                 else
-                    @logger.debug("Resending #{amount_of_documents} documents failed (error code #{response.code}), will try to resend for #{(remaining_duration - @logstashLoganalyticsConfiguration.RETRANSMISSION_DELAY)}")
-                    resend_message(documents_json, amount_of_documents, (remaining_duration - @logstashLoganalyticsConfiguration.RETRANSMISSION_DELAY))
+                    @logger.debug("Resending #{amount_of_documents} documents failed (error code #{response.code}), will try to resend for #{(remaining_duration - @logAnalyticsConfiguration.RETRANSMISSION_DELAY)}")
+                    resend_message(documents_json, amount_of_documents, (remaining_duration - @logAnalyticsConfiguration.RETRANSMISSION_DELAY))
                 end
             rescue Exception => ex
-                @logger.debug("Resending #{amount_of_documents} documents failed (Exception: '#{ex}'), will try to resend for #{(remaining_duration - @logstashLoganalyticsConfiguration.RETRANSMISSION_DELAY)}")
-                resend_message(documents_json, amount_of_documents, (remaining_duration - @logstashLoganalyticsConfiguration.RETRANSMISSION_DELAY))
+                @logger.debug("Resending #{amount_of_documents} documents failed (Exception: '#{ex}'), will try to resend for #{(remaining_duration - @logAnalyticsConfiguration.RETRANSMISSION_DELAY)}")
+                resend_message(documents_json, amount_of_documents, (remaining_duration - @logAnalyticsConfiguration.RETRANSMISSION_DELAY))
             end
         else 
             @logger.error("Could not resend #{amount_of_documents} documents, message is dropped.")
@@ -99,23 +99,23 @@ class LogStashAutoResizeBuffer
     # Meaning that if we reached the max amount we would like to increase it.
     # Else we would like to decrease it(to reduce latency for messages)
     def change_message_limit_size(amount_of_documents, documents_byte_size)
-        new_buffer_size = @logstashLoganalyticsConfiguration.max_items
+        new_buffer_size = @logAnalyticsConfiguration.max_items
         average_document_size = documents_byte_size / amount_of_documents
         # If window is full we need to increase it 
         # "amount_of_documents" can be greater since buffer is not synchronized meaning 
         # that flush can occur after limit was reached.
-        if  amount_of_documents >= @logstashLoganalyticsConfiguration.max_items
+        if  amount_of_documents >= @logAnalyticsConfiguration.max_items
             # if doubling the size wouldn't exceed the API limit
-            if ((2 * @logstashLoganalyticsConfiguration.max_items) * average_document_size) < @logstashLoganalyticsConfiguration.MAX_SIZE_BYTES
-                new_buffer_size = 2 * @logstashLoganalyticsConfiguration.max_items
+            if ((2 * @logAnalyticsConfiguration.max_items) * average_document_size) < @logAnalyticsConfiguration.MAX_SIZE_BYTES
+                new_buffer_size = 2 * @logAnalyticsConfiguration.max_items
             else
-                new_buffer_size = (@logstashLoganalyticsConfiguration.MAX_SIZE_BYTES / average_document_size) -1000
+                new_buffer_size = (@logAnalyticsConfiguration.MAX_SIZE_BYTES / average_document_size) -1000
             end
 
         # We would like to decrease the window but not more then the MIN_MESSAGE_AMOUNT
         # We are trying to decrease it slowly to be able to send as much messages as we can in one window 
-        elsif amount_of_documents < @logstashLoganalyticsConfiguration.max_items and  @logstashLoganalyticsConfiguration.max_items != [(@logstashLoganalyticsConfiguration.max_items - @logstashLoganalyticsConfiguration.decrease_factor) ,@logstashLoganalyticsConfiguration.MIN_MESSAGE_AMOUNT].max
-            new_buffer_size = [(@logstashLoganalyticsConfiguration.max_items - @logstashLoganalyticsConfiguration.decrease_factor) ,@logstashLoganalyticsConfiguration.MIN_MESSAGE_AMOUNT].max
+        elsif amount_of_documents < @logAnalyticsConfiguration.max_items and  @logAnalyticsConfiguration.max_items != [(@logAnalyticsConfiguration.max_items - @logAnalyticsConfiguration.decrease_factor) ,@logAnalyticsConfiguration.MIN_MESSAGE_AMOUNT].max
+            new_buffer_size = [(@logAnalyticsConfiguration.max_items - @logAnalyticsConfiguration.decrease_factor) ,@logAnalyticsConfiguration.MIN_MESSAGE_AMOUNT].max
         end
 
         change_buffer_size(new_buffer_size)
@@ -128,7 +128,7 @@ class LogStashAutoResizeBuffer
         if @buffer_config[:max_items] != new_size
             old_buffer_size = @buffer_config[:max_items]
             @buffer_config[:max_items] = new_size
-            @logstashLoganalyticsConfiguration.max_items = new_size
+            @logAnalyticsConfiguration.max_items = new_size
             @logger.info("Changing buffer size.[configuration='#{old_buffer_size}' , new_size='#{new_size}']")
         else
             @logger.info("Buffer size wasn't changed.[configuration='#{old_buffer_size}' , new_size='#{new_size}']")
@@ -140,4 +140,4 @@ class LogStashAutoResizeBuffer
         return (response.code == 200) ? true : false
       end # def is_successfully_posted
 
-end # LogStashAutoResizeBuffer
+end # LogAnalyticsAutoResizeBuffer

data/lib/logstash/{logAnalyticsClient/logstashLoganalyticsConfiguration.rb → azureLAClasses/logAnalyticsConfiguration.rb}

@@ -1,5 +1,5 @@
 # encoding: utf-8
-class LogstashLoganalyticsOutputConfiguration
+class LogAnalyticsConfiguration
     def initialize(workspace_id, workspace_key, custom_log_table_name, logger)
         @workspace_id = workspace_id
         @workspace_key = workspace_key

data/lib/logstash/outputs/sentinelblue-logstash-output-azure-loganalytics.rb

@@ -2,8 +2,8 @@
 require "logstash/outputs/base"
 require "logstash/namespace"
 require "stud/buffer"
-require "logstash/logAnalyticsClient/logStashAutoResizeBuffer"
-require "logstash/logAnalyticsClient/logstashLoganalyticsConfiguration"
+require "logstash/azureLAClasses/logAnalyticsAutoResizeBuffer"
+require "logstash/azureLAClasses/logAnalyticsConfiguration"
 
 class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
 
@@ -70,7 +70,7 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
     # Initialize the logstash resizable buffer
     # This buffer will increase and decrease size according to the amount of messages inserted.
     # If the buffer reached the max amount of messages the amount will be increased until the limit
-    # @logstash_resizable_event_buffer=LogStashAutoResizeBuffer::new(@logstash_configuration)
+    # @logstash_resizable_event_buffer=LogAnalyticsAutoResizeBuffer::new(@logstash_configuration)
 
   end # def register
 
@@ -127,7 +127,7 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
     
       else
         # If the buffer doesn't exist for the table, create one and add the document
-        buffers[custom_table_name] = LogStashAutoResizeBuffer::new(@logstash_configuration,custom_table_name)
+        buffers[custom_table_name] = LogAnalyticsAutoResizeBuffer::new(@logstash_configuration,custom_table_name)
         @logger.trace("Adding event document - " + event.to_s)
         buffers[custom_table_name].add_event_document(document)
 
@@ -163,9 +163,9 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
   end # def create_event_document
 
   # Building the logstash object configuration from the output configuration provided by the user
-  # Return LogstashLoganalyticsOutputConfiguration populated with the configuration values
+  # Return LogAnalyticsConfiguration populated with the configuration values
   def build_logstash_configuration()
-    logstash_configuration= LogstashLoganalyticsOutputConfiguration::new(@workspace_id, @workspace_key, @custom_log_table_name, @logger)    
+    logstash_configuration= LogAnalyticsConfiguration::new(@workspace_id, @workspace_key, @custom_log_table_name, @logger)    
     logstash_configuration.endpoint = @endpoint
     logstash_configuration.time_generated_field = @time_generated_field
     logstash_configuration.key_names = @key_names

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentinelblue-logstash-output-azure-loganalytics
 version: !ruby/object:Gem::Version
-  version: 1.1.2.rc1
+  version: 1.1.3.rc1
 platform: ruby
 authors:
 - Sentinel Blue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-28 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -86,9 +86,9 @@ files:
 - LICENSE
 - README.md
 - VERSION
-- lib/logstash/logAnalyticsClient/logAnalyticsClient.rb
-- lib/logstash/logAnalyticsClient/logStashAutoResizeBuffer.rb
-- lib/logstash/logAnalyticsClient/logstashLoganalyticsConfiguration.rb
+- lib/logstash/azureLAClasses/azureLAClient.rb
+- lib/logstash/azureLAClasses/logAnalyticsAutoResizeBuffer.rb
+- lib/logstash/azureLAClasses/logAnalyticsConfiguration.rb
 - lib/logstash/outputs/sentinelblue-logstash-output-azure-loganalytics.rb
 - sentinelblue-logstash-output-azure-loganalytics.gemspec
 - spec/outputs/azure_loganalytics_spec.rb