logstash-output-azure_loganalytics 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a8138f370979319233a8e0e551e54eb67fa21f5
-  data.tar.gz: 6f4947c3d33c113de24b037647f85571d2d702df
+  metadata.gz: c8478ec73e02eae91388307f89026500b140364d
+  data.tar.gz: 8ca5e7e57bf454b4f33ff614b5f9e25a76b1ea1c
 SHA512:
-  metadata.gz: 25f61fafc74d8ef5664d1af104d167f9299d15599a78da18846adcd4744ebee4c64843b0dc3dffdde7284b57a0a840807256852a166bb0036197cc7ab31e63ad
-  data.tar.gz: c4f424932fc52638ead8219234e90755180058ba06c0f88f607bdf78f56d33cce41f51c08a1c26d72b2220d7d705d572b890e9d0a5379c4d9b2c884fd0b823c4
+  metadata.gz: cf96615306ab45d89fa999a4ded0ed0da8f31e5b6caf01b1d473b57a36f16303d04211eda349944a27badd93fcea4da0fa632795eedb5b385ceb835f7b2448fa
+  data.tar.gz: d0762a739e1f30b70a0cf1084cdbfabdd75cea7ce6851eef6847e09d71543bb8bec9237a21e20fc8eea39a2213ea6367d6ca5d678244b5a31734312a111c9e9f

data/CHANGELOG.md

@@ -1,17 +1,45 @@
+## 0.6.0
+
+* Multithreading support - [PR #17](https://github.com/yokawasa/logstash-output-azure_loganalytics/pull/17) by [@daniel-chambers](https://github.com/daniel-chambers)
+  * Big performance improvement
+  * New parame `max_batch_items` is added
+  * No longer `flush_items` and `flush_interval_time` params are supported in the plugin configuration
+
+## 0.5.2
+
+* Fixed using sprintf in log_type - [PR #16](https://github.com/yokawasa/logstash-output-azure_loganalytics/pull/16) by [@daniel-chambers](https://github.com/daniel-chambers)
+
+## 0.5.1
+
+* Change base [azure-loganalytics-datacollector-api](https://github.com/yokawasa/azure-log-analytics-data-collector) to ">= 0.5.0"
+
+## 0.5.0
+
+* Support sprintf syntax like `%{my_log_type}` for `log_type` config param - [Issue #13](https://github.com/yokawasa/logstash-output-azure_loganalytics/issues/13)
+
+## 0.4.0
+
+* Change base [azure-loganalytics-datacollector-api](https://github.com/yokawasa/azure-log-analytics-data-collector) to ">= 0.4.0"
+
 ## 0.3.2
+
 * Improvement: removed unnecessary key check 
 
 ## 0.3.1
+
 * Performance optimization for large key_names list scenario - [Issue#10](https://github.com/yokawasa/logstash-output-azure_loganalytics/issues/10)
 
 ## 0.3.0
+
 * Support `key_types` param - [Issue#8](https://github.com/yokawasa/logstash-output-azure_loganalytics/issues/8)
 * Support custom log analytics API endpoint (for supporting Azure sovereign cloud) - [Issue#9](https://github.com/yokawasa/logstash-output-azure_loganalytics/issues/9)
 
 ## 0.2.3
+
 * Added additional debug logging for successful requests - [PR#7](https://github.com/yokawasa/logstash-output-azure_loganalytics/pull/7) by [@daniel-chambers](https://github.com/daniel-chambers)
 
 ## 0.2.2
+
 * Fix logging failure - [PR#6](https://github.com/yokawasa/logstash-output-azure_loganalytics/pull/6) by [@daniel-chambers](https://github.com/daniel-chambers)
 
 ## 0.2.1

data/README.md

@@ -1,6 +1,13 @@
 # Azure Log Analytics output plugin for Logstash 
 logstash-output-azure_loganalytics is a logstash plugin to output to Azure Log Analytics. [Logstash](https://www.elastic.co/products/logstash) is an open source, server-side data processing pipeline that ingests data from a multitude of sources simultaneously, transforms it, and then sends it to your favorite [destinations](https://www.elastic.co/products/logstash). [Log Analytics](https://azure.microsoft.com/en-us/services/log-analytics/) is a service in Operations Management Suite (OMS) that helps you collect and analyze data generated by resources in your cloud and on-premises environments. It gives you real-time insights using integrated search and custom dashboards to readily analyze millions of records across all of your workloads and servers regardless of their physical location. The plugin stores in-coming events to Azure Log Analytics by leveraging [Log Analytics HTTP Data Collector API](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api)
 
+> [NOTICE]
+> logstash-output-azure_loganalytics >= 0.6.0
+> - Multithreading support   
+> - New parame `max_batch_items` is added
+> - No longer `flush_items` and `flush_interval_time` params are supported in the plugin configuration
+
+
 ## Installation
 
 You can install this plugin using the Logstash "plugin" or "logstash-plugin" (for newer versions of Logstash) command:
@@ -21,15 +28,14 @@ output {
         log_type => "<LOG TYPE NAME>"
         key_names  => ['key1','key2','key3'..] ## list of Key names
         key_types => {'key1'=> 'string' 'key2'=>'double' 'key3'=>'boolean' .. }
-        flush_items => <FLUSH_ITEMS_NUM>
-        flush_interval_time => <FLUSH INTERVAL TIME(sec)>
+        max_batch_items => <MAX BATCH ITEMS (num)>
     }
 }
 ```
 
  * **customer\_id (required)** - Your Operations Management Suite workspace ID
  * **shared\_key (required)** - The primary or the secondary Connected Sources client authentication key.
- * **log\_type (required)** - The name of the event type that is being submitted to Log Analytics. This must be only alpha characters. 
+ * **log\_type (required)** - The name of the event type that is being submitted to Log Analytics. It must only contain alpha numeric and _, and not exceed 100 chars. sprintf syntax like `%{my_log_type}` is supported.
  * **time\_generated\_field (optional)** - Default:''(empty string) The name of the time generated field. Be carefule that the value of field should strictly follow the ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). See also [this](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api#create-a-request) for more details
  * **key\_names (optional)** - Default:[] (empty array). The list of key names in in-coming record that you want to submit to Log Analytics.
  * **key\_types (optional)** - Default:{} (empty hash). The list of data types for each column as which you want to store in Log Analytics (`string`, `boolean`, or `double`)
@@ -37,8 +43,7 @@ output {
    * Multiple key value entries are separated by `spaces` rather than commas (See also [this](https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html#hash))
    * If you want to store a column as datetime or guid data format, set `string` for the column ( the value of the column should be `YYYY-MM-DDThh:mm:ssZ format` if it's `datetime`, and `GUID format` if it's `guid`).
    * In case that `key_types` param are not specified, all columns that you want to submit ( you choose with `key_names` param ) are stored as `string` data type in Log Analytics.
- * **flush_items (optional)** - Default 50. Max number of items to buffer before flushing (1 - 1000).
- * **flush_interval_time (optional)** - Default 5. Max number of seconds to wait between flushes.
+ * **max_batch_items (optional)** - Default 50. Maximum number of log events to put in one request to Log Analytics.
 
 > [NOTE] There is a special param for changing the Log Analytics API endpoint (mainly for supporting Azure sovereign cloud)
 > * **endpoint (optional)** - Default: ods.opinsights.azure.com 

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.6.0

data/lib/logstash/outputs/azure_loganalytics.rb

@@ -2,11 +2,9 @@
 
 require "logstash/outputs/base"
 require "logstash/namespace"
-require "stud/buffer"
+require "securerandom"
 
 class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
-  include Stud::Buffer
-
   config_name "azure_loganalytics"
 
   # Your Operations Management Suite workspace ID
@@ -16,7 +14,8 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
   config :shared_key, :validate => :string, :required => true
 
   # The name of the event type that is being submitted to Log Analytics. 
-  # This must be only alpha characters.
+  # This must only contain alpha numeric and _, and not exceed 100 chars. 
+  # sprintf syntax like %{my_log_type} is supported.
   config :log_type, :validate => :string, :required => true
 
   # The service endpoint (Default: ods.opinsights.azure.com)
@@ -40,21 +39,15 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
   #   key_types => {'key1'=>'string' 'key2'=>'string' 'key3'=>'boolean' 'key4'=>'double' ...}
   config :key_types, :validate => :hash, :default => {}
 
-  # Max number of items to buffer before flushing. Default 50.
-  config :flush_items, :validate => :number, :default => 50
-  
-  # Max number of seconds to wait between flushes. Default 5
-  config :flush_interval_time, :validate => :number, :default => 5
+  # Maximum number of log events to put in one request to Log Analytics
+  config :max_batch_items, :validate => :number, :default => 50
+
+  concurrency :shared
 
   public
   def register
     require 'azure/loganalytics/datacollectorapi/client'
 
-    ## Configure
-    if not @log_type.match(/^[[:alpha:]]+$/)
-      raise ArgumentError, 'log_type must be only alpha characters' 
-    end
-
     @key_types.each { |k, v|
       t = v.downcase
       if ( !t.eql?('string') && !t.eql?('double') && !t.eql?('boolean') ) 
@@ -65,27 +58,20 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
     ## Start 
     @client=Azure::Loganalytics::Datacollectorapi::Client::new(@customer_id,@shared_key,@endpoint)
 
-    buffer_initialize(
-      :max_items => @flush_items,
-      :max_interval => @flush_interval_time,
-      :logger => @logger
-    )
-
   end # def register
 
   public
-  def receive(event)
-    # Simply save an event for later delivery
-    buffer_receive(event)
-  end # def receive
+  def multi_receive(events)
+    
+    flush_guid = SecureRandom.uuid
+    @logger.debug("Start receive: #{flush_guid}. Received #{events.length} events")
 
-  # called from Stud::Buffer#buffer_flush when there are events to flush
-  public
-  def flush (events, close=false)
-  
-    documents = []  #this is the array of hashes to add Azure Log Analytics
+    documentsByLogType = {}  # This is a map of log_type to list of documents (themselves maps) to send to Log Analytics
     events.each do |event|
       document = {}
+      
+      log_type_for_event = event.sprintf(@log_type)
+
       event_hash = event.to_hash()
       if @key_names.length > 0
         # Get the intersection of key_names and keys of event_hash
@@ -103,27 +89,36 @@ class LogStash::Outputs::AzureLogAnalytics < LogStash::Outputs::Base
       # Skip if document doesn't contain any items
       next if (document.keys).length < 1
 
-      documents.push(document)
+      if documentsByLogType[log_type_for_event] == nil then
+        documentsByLogType[log_type_for_event] = []
+      end
+      documentsByLogType[log_type_for_event].push(document)
     end
 
     # Skip in case there are no candidate documents to deliver
-    if documents.length < 1
-      @logger.debug("No documents in batch for log type #{@log_type}. Skipping")
+    if documentsByLogType.length < 1
+      @logger.debug("No documents in batch. Skipping")
       return
     end
 
-    begin
-      @logger.debug("Posting log batch (log count: #{documents.length}) as log type #{@log_type} to DataCollector API. First log: " + (documents[0].to_json).to_s)
-      res = @client.post_data(@log_type, documents, @time_generated_field)
-      if Azure::Loganalytics::Datacollectorapi::Client.is_success(res)
-        @logger.debug("Successfully posted logs as log type #{@log_type} with result code #{res.code} to DataCollector API")
-      else
-        @logger.error("DataCollector API request failure: error code: #{res.code}, data=>" + (documents.to_json).to_s)
+    documentsByLogType.each do |log_type_for_events, events|
+      events.each_slice(@max_batch_items) do |event_batch|
+        begin
+          @logger.debug("Posting log batch (log count: #{event_batch.length}) as log type #{log_type_for_events} to DataCollector API. First log: " + (event_batch[0].to_json).to_s)
+          res = @client.post_data(log_type_for_events, event_batch, @time_generated_field)
+          if Azure::Loganalytics::Datacollectorapi::Client.is_success(res)
+            @logger.debug("Successfully posted logs as log type #{log_type_for_events} with result code #{res.code} to DataCollector API")
+          else
+            @logger.error("DataCollector API request failure (log type #{log_type_for_events}): error code: #{res.code}, data=>" + (event_batch.to_json).to_s)
+          end
+        rescue Exception => ex
+          @logger.error("Exception occured in posting to DataCollector API as log type #{log_type_for_events}: '#{ex}', data=>" + (event_batch.to_json).to_s)
+        end
       end
-    rescue Exception => ex
-      @logger.error("Exception occured in posting to DataCollector API: '#{ex}', data=>" + (documents.to_json).to_s)
     end
-  end # def flush
+    @logger.debug("End receive: #{flush_guid}")
+
+  end # def multi_receive
 
   private
   def convert_value(type, val)

data/logstash-output-azure_loganalytics.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "rest-client", ">= 1.8.0"
-  s.add_runtime_dependency "azure-loganalytics-datacollector-api", ">= 0.1.5"
+  s.add_runtime_dependency "azure-loganalytics-datacollector-api", ">= 0.5.0"
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency "logstash-codec-plain"
   s.add_development_dependency "logstash-devutils"

data/spec/outputs/azure_loganalytics_spec.rb

@@ -28,7 +28,7 @@ describe LogStash::Outputs::AzureLogAnalytics do
      azure_loganalytics_output.register
   end 
 
-  describe "#flush" do
+  describe "#multi_receive" do
     it "Should successfully send the event to Azure Log Analytics" do
       events = []
       log1 = {
@@ -61,11 +61,9 @@ describe LogStash::Outputs::AzureLogAnalytics do
 
       event1 =  LogStash::Event.new(log1) 
       event2 =  LogStash::Event.new(log2) 
-      azure_loganalytics_output.receive(event1)
-      azure_loganalytics_output.receive(event2)
       events.push(event1)
       events.push(event2)
-      expect {azure_loganalytics_output.flush(events)}.to_not raise_error
+      expect {azure_loganalytics_output.multi_receive(events)}.to_not raise_error
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-azure_loganalytics
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Yoichi Kawasaki
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.5.0
   name: azure-loganalytics-datacollector-api
   prerelease: false
   type: :runtime
@@ -37,7 +37,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: