microsoft-sentinel-log-analytics-logstash-output-plugin 1.1.4 → 2.2.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b93ef7e00ec54fd6aea1712b10a16947a3bf4a226a7992897ae5e6fb2f7708
-  data.tar.gz: 712e6f247d574d5b48bb87693af44098401246c192ab886d0b3960c318861491
+  metadata.gz: ea487790648bd37da80785720d41eba04d6e25d26b51acd4dedaae12d4df788e
+  data.tar.gz: 2c5e07886e64407c588ebae4d080796ae83e4a5c24a6dd287cc91a8858e1bea4
 SHA512:
-  metadata.gz: 66758c4c92a88a28a81b19161dc1e55d727675ad5f788d6abfce1a495603de7a601a0f4fd9ee35c8ad746a3f782b019cf7343c3c9c472c3f2ddf03a8a1b348f1
-  data.tar.gz: 234aee955f0a3ce3a1dbb5c84f620d87ef350053491a716e57feb15282fddf2cce69003add06ef73bf017fa682d9c5e165cfe1b7ad3bc158e1f6a9bf21ec55a8
+  metadata.gz: 0a76b54722684ef96a897363bfe0b2104dc14c99ef7e196585a8e6ae2e03606e330c16ece586a262148a41cfee41797304ec8ecde13cdc3839005645b808d79c
+  data.tar.gz: d18a87da9ac8d7b5f19c3be49744d0ed7051b343fda7a8dc9dbb52c4f88c3c83dcb81310cbae590c910f0a2adb539c5dfe8ed4118303f4f24eb5969c7fe248a2

data/CHANGELOG.md

@@ -1,16 +1,18 @@
-## 1.1.4
--  Limit `excon` library version to lower than 1.0.0 to make sure port is always used when using a proxy.
-  
-## 1.1.3
--  Replaces the `rest-client` library used for connecting to Azure with the `excon` library.
- 
-## 1.1.1
-- Adds support for Azure US Government cloud and Microsoft Azure operated by 21Vianet in China.
- 
-## 1.1.0 
-- Allows setting different proxy values for API connections.
-- Upgrades version for logs ingestion API to 2023-01-01.
-- Renames the plugin to microsoft-sentinel-log-analytics-logstash-output-plugin.
- 
-## 1.0.0
-- The initial release for the Logstash output plugin for Microsoft Sentinel. This plugin uses Data Collection Rules (DCRs) with Azure Monitor's Logs Ingestion API.
+## 2.2.1
+- Adds info-level logging line when batches are successfully sent.
+
+## 2.2.0
+- Adds ability to use either new or old configuration values.
+
+## 2.1.2
+- Documentation updates
+
+## 2.1.1
+- Improved efficiency.
+
+## 2.1.0
+- Fixed event normalization.
+
+## 2.0.0
+- Refactored the plugin from Ruby to Java.
+- Added ManagedIdentity authentication.

data/Gemfile

@@ -1,2 +1,12 @@
-source 'https://rubygems.org'
-gemspec
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/README.md

@@ -1,258 +1,251 @@
-# Microsoft Sentinel output plugin for Logstash 
-
-Microsoft Sentinel provides a new output plugin for Logstash. Use this output plugin to send any log via Logstash to the Microsoft Sentinel/Log Analytics workspace. This is done with the Log Analytics DCR-based API.
-You may send logs to custom or standard tables.
-
-Plugin version: v1.1.3  
-Released on: 2024-10-10
-
-This plugin is currently in development and is free to use. We welcome contributions from the open source community on this project, and we request and appreciate feedback from users.
-
-## Installation Instructions
-1) Install the plugin
-2) Create a sample file
-3) Create the required DCR-related resources
-4) Configure Logstash configuration file
-5) Basic logs transmission
-
-
-## 1. Install the plugin
-
-Microsoft Sentinel provides Logstash output plugin to Log analytics workspace using DCR based logs API.
-
-The plugin is published on [RubyGems](https://rubygems.org/gems/microsoft-sentinel-log-analytics-logstash-output-plugin). To install to an existing logstash installation, run `logstash-plugin install microsoft-sentinel-log-analytics-logstash-output-plugin`.
-
-If you do not have a direct internet connection, you can install the plugin to another logstash installation, and then export and import a plugin bundle to the offline host. For more information, see [Logstash Offline Plugin Management instruction](<https://www.elastic.co/guide/en/logstash/current/offline-plugins.html>).  
-
-Microsoft Sentinel's Logstash output plugin supports the following versions
-- 7.0 - 7.17.13
-- 8.0 - 8.9
-- 8.11 - 8.15
-
-Please note that when using Logstash 8, it is recommended to disable ECS in the pipeline. For more information refer to [Logstash documentation.](<https://www.elastic.co/guide/en/logstash/8.4/ecs-ls.html>)
-
-
-## 2. Create a sample file
-To create a sample file, follow the following steps:
-1)	Copy the output plugin configuration below to your Logstash configuration file:
-```
-output {
-    microsoft-sentinel-log-analytics-logstash-output-plugin {
-        create_sample_file => true
-        sample_file_path => "<enter the path to the file in which the sample data will be written>" #for example: "c:\\temp" (for windows) or "/var/log" for Linux.
-    }
-}
-```
-Note: make sure that the path exists before creating the sample file.
-2) Start Logstash. The plugin will collect up to 10 records to a sample.
-3) The file named "sampleFile<epoch seconds>.json" in the configured path will be created once there are 10 events to sample or when the Logstash process exited gracefully. (for example: "c:\temp\sampleFile1648453501.json").
-
-
-### Configurations:
-The following parameters are optional and should be used to create a sample file.
-- **create_sample_file** - Boolean, False by default. When enabled, up to 10 events will be written to a sample json file.
-- **sample_file_path** - Number, Empty by default. Required when create_sample_file is enabled. Should include a valid path in which to place the sample file generated.
-
-### Complete example
-1. set the pipeline.conf with the following configuration:
-```
-input {
-      generator {
-        lines => [ "This is a test log message"]
-        count => 10
-      }
-}
-
-output {
-    microsoft-sentinel-log-analytics-logstash-output-plugin {
-        create_sample_file => true
-        sample_file_path => "<enter the path to the file in which the sample data will be written>" #for example: "c:\\temp" (for windows) or "/var/log" for Linux.
-    }
-}
-```
-
-2. the following sample file will be generated:
-```
-[
-	{
-		"host": "logstashMachine",
-		"sequence": 0,
-		"message": "This is a test log message",
-		"ls_timestamp": "2022-10-29T13:19:28.116Z",
-		"ls_version": "1"
-	},
-	...
-]
-```
-
-## 3. Create the required DCR-related resources
-To configure Microsoft Sentinel Logstash plugin you first need to create the DCR-related resources. To create these resources, follow one of the following tutorials:
-1) To ingest the data to a custom table use [Tutorial - Send custom logs to Azure Monitor Logs (preview) - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs>) tutorial. Note that as part of creating the table and the DCR you will need to provide the sample file that you've created in the previous section.
-2) To ingest the data to a standard table like Syslog or CommonSecurityLog use [Tutorial - Send custom logs to Azure Monitor Logs using resource manager templates - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs-api>).
-
-
-## 4. Configure Logstash configuration file
-
-Use the tutorial from the previous section to retrieve the following attributes: 
-- **client_app_Id** - String, The 'Application (client) ID' value created in step #3 of the "Configure Application" section of the tutorial you used in the previous step.
-- **client_app_secret** -String, The value of the client secret created in step #5 of the "Configure Application" section of the tutorial you used in the previous step.
-- **tenant_id** - String, Your subscription's tenant id. You can find in the following path: Home -> Azure Active Directory -> Overview Under 'Basic Information'.
-- **data_collection_endpoint** - String, - The value of the logsIngestion URI (see step #3 of the "Create data collection endpoint" section in Tutorial [Tutorial - Send custom logs to Azure Monitor Logs using resource manager templates - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs-api#create-data-collection-endpoint>).
-- **dcr_immutable_id** - String, The value of the DCR immutableId (see the "Collect information from DCR" section in [Tutorial - Send custom logs to Azure Monitor Logs (preview) - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs#collect-information-from-dcr>).
-- **dcr_stream_name** - String, The name of the data stream (Go to the json view of the DCR as explained in the "Collect information from DCR" section in [Tutorial - Send custom logs to Azure Monitor Logs (preview) - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs#collect-information-from-dcr>) and copy the value of the "dataFlows -> streams" property (see circled in red in the below example).
-
-After retrieving the required values replace the output section of the Logstash configuration file created in the previous steps with the example below. Then, replace the strings in the brackets below with the corresponding values. Make sure you change the "create_sample_file" attribute to false.
-
-Here is an example for the output plugin configuration section:
-```
-output {
-    microsoft-sentinel-log-analytics-logstash-output-plugin {
-        client_app_Id => "<enter your client_app_id value here>"
-        client_app_secret => "<enter your client_app_secret value here>"
-        tenant_id => "<enter your tenant id here>"
-        data_collection_endpoint => "<enter your DCE logsIngestion URI here>"
-        dcr_immutable_id => "<enter your DCR immutableId here>"
-        dcr_stream_name => "<enter your stream name here>"
-        create_sample_file=> false
-        sample_file_path => "c:\\temp"
-    }
-}
-
-```
-### Optional configuration 
-- **key_names** – Array of strings, if you wish to send a subset of the columns to Log Analytics.
-- **plugin_flush_interval** – Number, 5 by default. Defines the maximal time difference (in seconds) between sending two messages to Log Analytics. 
-- **retransmission_time** - Number, 10 by default. This will set the amount of time in seconds given for retransmitting messages once sending has failed. 
-- **compress_data** - Boolean, false by default. When this field is true, the event data is compressed before using the API. Recommended for high throughput pipelines
-- **proxy** - String, Empty by default. Specify which proxy URL to use for API calls for all of the communications with Azure.
-- **proxy_aad** - String, Empty by default. Specify which proxy URL to use for API calls for the Azure Active Directory service. Overrides the proxy setting.
-- **proxy_endpoint** - String, Empty by default. Specify which proxy URL to use when sending log data to the endpoint. Overrides the proxy setting.
-- **azure_cloud** - String, Empty by default. Used to specify the name of the Azure cloud that is being used, AzureCloud is set as default. Available values are: AzureCloud, AzureChinaCloud and AzureUSGovernment.
-
-#### Note: When setting an empty string as a value for a proxy setting, it will unset any system wide proxy setting.
-
-Security notice: We recommend not to implicitly state client_app_Id, client_app_secret, tenant_id, data_collection_endpoint, and dcr_immutable_id in your Logstash configuration for security reasons.
-                 It is best to store this sensitive information in a Logstash KeyStore as described here- ['Secrets Keystore'](<https://www.elastic.co/guide/en/logstash/current/keystore.html>)
-
-
-## 5. Basic logs transmission
-
-Here is an example configuration that parses Syslog incoming data into a custom stream named "Custom-MyTableRawData".
-
-### Example Configuration
-
-- Using filebeat input pipe
-
-```
-input {
-    beats {
-        port => "5044"
-    }
-}
- filter {
-}
-output {
-    microsoft-sentinel-log-analytics-logstash-output-plugin {
-      client_app_Id => "619c1731-15ca-4403-9c61-xxxxxxxxxxxx"
-      client_app_secret => "xxxxxxxxxxxxxxxx"
-      tenant_id => "72f988bf-86f1-41af-91ab-xxxxxxxxxxxx"
-      data_collection_endpoint => "https://my-customlogsv2-test-jz2a.eastus2-1.ingest.monitor.azure.com"
-      dcr_immutable_id => "dcr-xxxxxxxxxxxxxxxxac23b8978251433a"
-      dcr_stream_name => "Custom-MyTableRawData"
-      proxy_aad => "http://proxy.example.com"
-    }
-}
-
-```
-- Or using the tcp input pipe
-
-```
-input {
-    tcp {
-        port => "514"
-        type => syslog #optional, will effect log type in table
-    }
-}
- filter {
-}
-output {
-    microsoft-sentinel-log-analytics-logstash-output-plugin {
-      client_app_Id => "619c1731-15ca-4403-9c61-xxxxxxxxxxxx"
-      client_app_secret => "xxxxxxxxxxxxxxxx"
-      tenant_id => "72f988bf-86f1-41af-91ab-xxxxxxxxxxxx"
-      data_collection_endpoint => "https://my-customlogsv2-test-jz2a.eastus2-1.ingest.monitor.azure.com"
-      dcr_immutable_id => "dcr-xxxxxxxxxxxxxxxxac23b8978251433a"
-      dcr_stream_name => "Custom-MyTableRawData"
-    }
-}
-```
-
-<u>Advanced Configuration</u>
-```
-input {
-  syslog {
-    port => 514
-  }
-}
-
-output {
-    microsoft-sentinel-log-analytics-logstash-output-plugin {
-      client_app_Id => "${CLIENT_APP_ID}"
-      client_app_secret => "${CLIENT_APP_SECRET}"
-      tenant_id => "${TENANT_ID}"
-      data_collection_endpoint => "${DATA_COLLECTION_ENDPOINT}"
-      dcr_immutable_id => "${DCR_IMMUTABLE_ID}"
-      dcr_stream_name => "Custom-MyTableRawData"
-	  key_names => ['PRI','TIME_TAG','HOSTNAME','MSG']
-    }
-}
-
-```
-
-Now you are able to run logstash with the example configuration and send mock data using the 'logger' command.
-
-For example: 
-```
-logger -p local4.warn --rfc3164 --tcp -t CEF "0|Microsoft|Device|cef-test|example|data|1|here is some more data for the example" -P 514 -d -n 127.0.0.1
-```
-
-Which will produce this content in the sample file:
-
-```
-[
-	{
-		"logsource": "logstashMachine",
-		"facility": 20,
-		"severity_label": "Warning",
-		"severity": 4,
-		"timestamp": "Apr  7 08:26:04",
-		"program": "CEF:",
-		"host": "127.0.0.1",
-		"facility_label": "local4",
-		"priority": 164,
-		"message": "0|Microsoft|Device|cef-test|example|data|1|here is some more data for the example",
-		"ls_timestamp": "2022-04-07T08:26:04.000Z",
-		"ls_version": "1"
-	}
-]
-```
-
-
-## Known issues
- 
-When using Logstash installed on a Docker image of Lite Ubuntu, the following warning may appear:
-
-```
-java.lang.RuntimeException: getprotobyname_r failed
-```
-
-To resolve it, use the following commands to install the *netbase* package within your Dockerfile:
-```bash
-USER root
-RUN apt install netbase -y
-```
-For more information, see [JNR regression in Logstash 7.17.0 (Docker)](https://github.com/elastic/logstash/issues/13703).
-
-If your environment's event rate is low considering the number of allocated Logstash workers, we recommend increasing the value of *plugin_flush_interval* to 60 or more. This change will allow each worker to batch more events before uploading to the Data Collection Endpoint (DCE).  You can monitor the ingestion payload using [DCR metrics](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-monitor#dcr-metrics).
-For more information on *plugin_flush_interval*, see the [Optional Configuration table](https://learn.microsoft.com/azure/sentinel/connect-logstash-data-connection-rules#optional-configuration) mentioned earlier.
-
+# Microsoft Sentinel Output Plugin for Logstash 
+
+Microsoft Sentinel provides a new output plugin for Logstash. Use this output plugin to send any log via Logstash to the Microsoft Sentinel/Log Analytics workspace. This is done with the Log Analytics DCR-based API.
+You may send logs to custom or standard tables.  
+
+Plugin version: v2.2.1  
+Released on: 2026-05-27  
+
+This plugin is currently in development and is free to use. We request and appreciate feedback from users.  
+
+## Installation Instructions
+1) Install the plugin  
+2) Create a sample file  
+3) Create the required DCR-related resources  
+4) Configure Logstash configuration file  
+
+
+## 1. Install the plugin
+
+Microsoft Sentinel provides Logstash output plugin to Log analytics workspace using DCR based logs API.  
+
+The plugin is published on [RubyGems](https://rubygems.org/gems/microsoft-sentinel-log-analytics-logstash-output-plugin). To install to an existing logstash installation, run `logstash-plugin install microsoft-sentinel-log-analytics-logstash-output-plugin`.  
+
+If you do not have a direct internet connection, you can install the plugin to another logstash installation, and then export and import a plugin bundle to the offline host. For more information, see [Logstash Offline Plugin Management instruction](<https://www.elastic.co/guide/en/logstash/current/offline-plugins.html>).  
+
+Microsoft Sentinel's Logstash output plugin supports the following versions  
+- 7.0 - 7.17.13  
+- 8.0 - 8.9 (NOTE: these versions require a security update, according to Logstash!)  
+- 8.11 - 8.15 (NOTE: these versions require a security update, according to Logstash!)  
+- 8.19.2 (NOTE: this version requires a security update, according to Logstash!)  
+- 9.0.8 (NOTE: this version requires a security update, according to Logstash!)  
+- 9.1.10 (NOTE: this version requires a security update, according to Logstash!)  
+- 9.2.4 - 9.2.5 (NOTE: these versions require a security update, according to Logstash! [Security Update](https://discuss.elastic.co/t/logstash-8-19-14-9-2-8-9-3-3-security-update-esa-2026-29/385816))  
+- 9.3.3
+
+Please note that when using Logstash 8, it is recommended to disable ECS in the pipeline. For more information refer to [Logstash documentation.](<https://www.elastic.co/guide/en/logstash/8.4/ecs-ls.html>)  
+
+## 2. Create a sample file
+To create a sample file, follow the following steps:  
+1)	Copy the output plugin configuration below to your Logstash configuration file:  
+    ```
+    output {
+        microsoft-sentinel-log-analytics-logstash-output-plugin {
+            create_sample_file => true
+            sample_file_path => "<enter the path to the file in which the sample data will be written>" #for example: "c:\\temp" (for windows) or "/var/log" for Linux.
+        }
+    }
+    ```
+Note: make sure that the path exists before creating the sample file.  
+2) Start Logstash. The plugin will collect up to 10 records to a sample.  
+3) The file named "sampleFile<epoch seconds>.json" in the configured path will be created once there are 10 events to sample or when the Logstash process exited gracefully. (for example: "c:\temp\sampleFile1648453501.json").  
+
+
+### Configurations:
+The following parameters are optional and should be used to create a sample file.  
+- **create_sample_file** - Boolean, False by default. When enabled, up to 10 events will be written to a sample json file.  
+- **sample_file_path** - Number, Empty by default. Required when create_sample_file is enabled. Should include a valid path in which to place the sample file generated.  
+
+### Complete example
+1. set the pipeline.conf with the following configuration:  
+    ```
+    input {
+          generator {
+            lines => [ "This is a test log message"]
+            count => 10
+          }
+    }
+
+    output {
+        microsoft-sentinel-log-analytics-logstash-output-plugin {
+            create_sample_file => true
+            sample_file_path => "<enter the path to the file in which the sample data will be written>" #for example: "c:\\temp" (for windows) or "/var/log" for Linux.
+        }
+    }
+    ```
+
+2. the following sample file will be generated:  
+    ```
+    [
+      {
+        "host": "logstashMachine",
+        "sequence": 0,
+        "message": "This is a test log message",
+        "ls_timestamp": "2022-10-29T13:19:28.116Z",
+        "ls_version": "1"
+      },
+      ...
+    ]
+    ```
+
+## 3. Create the required DCR-related resources
+To configure Microsoft Sentinel Logstash plugin you first need to create the DCR-related resources. To create these resources, follow one of the following tutorials:  
+1) To ingest the data to a custom table use [Tutorial - Send custom logs to Azure Monitor Logs (preview) - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs>) tutorial. Note that as part of creating the table and the DCR you will need to provide the sample file that you've created in the previous section.  
+2) To ingest the data to a standard table like Syslog or CommonSecurityLog use [Tutorial - Send custom logs to Azure Monitor Logs using resource manager templates - Azure Monitor | Microsoft Docs](<https://docs.microsoft.com/azure/azure-monitor/logs/tutorial-custom-logs-api>).  
+
+*Note:* The identity (service principal or managed identity) must have the **Monitoring Metrics Publisher** role on the target DCR:  
+
+    ```
+    az role assignment create \
+      --assignee <object-id-of-identity> \
+      --role "Monitoring Metrics Publisher" \
+      --scope "/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.Insights/dataCollectionRules/<dcr-name>"
+    ```
+
+
+## 4. Configure the Output Plugin
+
+Add the `microsoft-sentinel-log-analytics-logstash-output-plugin` block to the `output` section of your Logstash configuration file (e.g., `logstash.conf`). The plugin requires three values from your Azure DCR resources plus authentication credentials depending on your method.  
+
+### Required Config Values (needed for all methods)
+
+| Key | Description |  
+|---|---|  
+| `data_collection_endpoint` | Your DCE logsIngestion URI |  
+| `dcr_id` | The immutable ID of your Data Collection Rule |  
+| `stream_name` | The stream name from your DCR (e.g., `Custom-MyTableRawData_CL`) |  
+
+---
+
+### Authentication Examples
+
+The plugin auto-detects the auth method based on which config values are present.  
+
+#### Option 1: Client Secret (App Registration)
+
+Provide `client_id`, `client_secret`, and `tenant_id` for your Azure App Registration / service principal.  
+
+    ```
+    output {
+      microsoft-sentinel-log-analytics-logstash-output-plugin {
+        data_collection_endpoint => "https://<your-dce-name>.<region>.ingest.monitor.azure.com"
+        dcr_id                   => "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+        stream_name              => "Custom-MyTableRawData_CL"
+        client_id                => "<your-app-client-id>"
+        client_secret            => "<your-app-client-secret>"
+        tenant_id                => "<your-azure-tenant-id>"
+      }
+    }
+    ```
+
+
+#### Option 2: Managed Identity
+
+When running on an Azure VM with a system-assigned managed identity, omit `client_id`, `client_secret`, and `tenant_id`. The plugin will automatically use the VM's managed identity.  
+
+    ```
+    output {
+      microsoft-sentinel-log-analytics-logstash-output-plugin {
+        data_collection_endpoint => "https://<your-dce-name>.<region>.ingest.monitor.azure.com"
+        dcr_id                   => "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+        stream_name              => "Custom-MyTableRawData_CL"
+      }
+    }
+    ```
+
+#### Option 3: Client Secret + Sovereign Cloud
+
+To authenticate against a sovereign cloud, add `azure_cloud`. Supported values: `AzurePublicCloud` (default), `AzureUSGovernment`, `AzureChinaCloud`, `AzureGermanyCloud`.  
+
+    ```
+    output {
+      microsoft-sentinel-log-analytics-logstash-output-plugin {
+        data_collection_endpoint => "https://<your-dce-ingestion-endpoint>"
+        dcr_id                   => "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+        stream_name              => "Custom-MyTableRawData_CL"
+        client_id                => "<your-app-client-id>"
+        client_secret            => "<your-app-client-secret>"
+        tenant_id                => "<your-tenant-id>"
+        azure_cloud              => "AzureUSGovernment"
+      }
+    }
+    ```
+
+#### Option 4: Managed Identity + Sovereign Cloud
+
+    ```
+    output {
+      microsoft-sentinel-log-analytics-logstash-output-plugin {
+        data_collection_endpoint => "https://<your-dce-ingestion-endpoint>"
+        dcr_id                   => "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+        stream_name              => "Custom-MyTableRawData_CL"
+        azure_cloud              => "AzureUSGovernment"
+      }
+    }
+    ```
+---
+Security notice: We recommend not to implicitly state client_id, client_secret, tenant_id, data_collection_endpoint, and dcr_id in your Logstash configuration for security reasons.  
+                 It is best to store this sensitive information in a Logstash KeyStore as described here- ['Secrets Keystore'](<https://www.elastic.co/guide/en/logstash/current/keystore.html>)  
+
+---
+
+## Full Pipeline Example
+
+A complete `logstash.conf` using client secret auth with a Beats input:  
+
+    ```
+    input {
+      beats {
+        port => 5044
+      }
+    }
+
+    filter {
+    }
+
+    output {
+      microsoft-sentinel-log-analytics-logstash-output-plugin {
+        data_collection_endpoint => "https://my-dce.eastus2-1.ingest.monitor.azure.com"
+        dcr_id                   => "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+        stream_name              => "Custom-MyTableRawData_CL"
+        client_id                => "619c1731-15ca-4403-9c61-xxxxxxxxxxxx"
+        client_secret            => "xxxxxxxxxxxxxxxx"
+        tenant_id                => "72f988bf-86f1-41af-91ab-xxxxxxxxxxxx"
+      }
+    }
+    ```
+---
+
+## Optional Config Values
+
+| Key | Default | Description |  
+|---|---|---|  
+| `azure_cloud` | `AzurePublicCloud` | Azure cloud environment |  
+| `keys_to_keep` | *(all)* | Array of field names to send (subset filtering) |  
+| `max_retries_num` | `3` | Max retry attempts for failed sends |  
+| `initial_wait_time_seconds` | `1` | Initial backoff between retries |  
+| `max_graceful_shutdown_time_seconds` | `60` | Max wait for graceful shutdown |  
+| `max_waiting_time_for_batch_seconds` | `10` | Max wait before flushing a batch |  
+| `max_waiting_for_unifier_time_seconds` | `10` | Max wait before flushing the unifier |  
+| `max_batch_size` | `10000` | Maximum number of events per batch. When a batch reaches this size it is flushed immediately, regardless of the time window |  
+| `input_queue_capacity` | `50000` | Maximum capacity of the input queue. Bounds memory usage under high-volume ingestion. When full, back-pressure is applied to the Logstash pipeline |  
+| `internal_queue_capacity` | `500` | Maximum capacity of the internal queues between batcher, unifier, and sender workers. Bounds memory usage for in-flight batches |  
+| `worker_sleep_time_millis` | `10` | Delay between worker iterations |  
+| `batcher_workers_count` | *(auto)* | Number of batcher threads |  
+| `sender_workers_count` | *(auto)* | Number of sender threads |  
+| `unifier_workers_count` | *(auto)* | Number of unifier threads |  
+
+## Known issues
+ 
+When using Logstash installed on a Docker image of Lite Ubuntu, the following warning may appear:  
+
+    ```
+    java.lang.RuntimeException: getprotobyname_r failed
+    ```
+
+To resolve it, use the following commands to install the *netbase* package within your Dockerfile:  
+    ```
+    USER root
+    RUN apt install netbase -y
+    ```
+For more information, see [JNR regression in Logstash 7.17.0 (Docker)](https://github.com/elastic/logstash/issues/13703).  

data/VERSION

@@ -0,0 +1 @@
+2.2.1