microsoft-sentinel-logstash-output 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3314cd9fbec5bd71add1de243e0474739dfe43aa1bd7a498c316066681306d8
+  data.tar.gz: 8ddab05b2acceb5d15a051b5134ccb7ea12b6efb22fb1712192d1a00bfac60ff
+SHA512:
+  metadata.gz: efafed55777a2757fb3c1416b8bbf6e4e8653fd45cd08a26bda22d997a7dd9aac4624b7d5854df24e4de9f50deed4d1d1c8cadf69aab9e4197d8219615416db6
+  data.tar.gz: 0b75c805e3e640df6cfcdcdc6646ee2e158b9c2c5c0c5caa1b24f2823270d70b0e148df76207d94508440f0877aa5b6c2a9111a6a8a79b7a3e166eab94106661

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 1.0.0
+* Initial release for output plugin for logstash to Microsoft Sentinel. This is done with the Log Analytics DCR based API.
+
+## 1.1.0 
+* Increase timeout for read/open connections to 120 seconds.
+* Add error handling for when connection timeout occurs.
+* Upgrade the rest-client dependency minimum version to 2.1.0.
+* Allow setting different proxy values for api connections.
+* Upgrade version for ingestion api to 2023-01-01.
+* Rename the plugin to microsoft-sentinel-log-analytics-logstash-output-plugin.
+
+## 1.1.1
+* Support China and US Government Azure sovereign clouds.
+* Increase timeout for read/open connections to 240 seconds.
+
+## 1.2.0
+* Added support for Managed Identity authentication on both Azure VMs and Azure Arc connected machines.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE

data/README.md

@@ -0,0 +1,278 @@
+# 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.2.0
+Released on: 2024-02-23
+
+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.
+
+## Steps to implement the output plugin
+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 Logstash and the plugin
+
+Microsoft Sentinel provides Logstash output plugin to Log analytics workspace using DCR based logs API.
+
+Microsoft Sentinel's Logstash output plugin supports the following versions
+- 7.0 - 7.17.13
+- 8.0 - 8.9
+- 8.11
+
+```
+wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/elastic.gpg >/dev/null
+echo "deb https://artifacts.elastic.co/packages/8.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-8.x.list >/dev/null
+sudo apt-get update && sudo apt-get install logstash=1:8.8.1-1
+```
+
+To make sure Logstash isn't automatically updated to a newer version, make sure its package is on hold for automatic updates:
+
+```
+sudo apt-mark hold logstash
+```
+
+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>)
+
+To install the microsoft-sentinel-log-analytics-logstash-output-plugin, you can make use of the published gem at rubygems.com:
+
+```
+sudo /usr/share/logstash/bin/logstash-plugin install microsoft-sentinel-log-analytics-logstash-output-plugin
+```
+
+If your machine doesn't has an active Internet connection, or you want to install the plugin manually, you can download the plugin files and perform an 'offline' installation. [Logstash Offline Plugin Management instruction](<https://www.elastic.co/guide/en/logstash/current/offline-plugins.html>).
+
+If you already have the plugin installed, you can check which version you have by running:
+
+```
+sudo /usr/share/logstash/bin/logstash-plugin list --verbose microsoft-sentinel-log-analytics-logstash-output-plugin
+```
+
+## 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 -> Microsoft Entra ID -> 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
+
+- **managed_identity** - Boolean, false by default. Set to `true` if you'd whish to authenticate using a Managed Identity. Managed Identities provide a "passwordless" authentication solution. This means providing `client_app_id`, `client_app_secret` and `tenant_id` is no longer requird. [Learn more about using anaged Identities](<https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview>).
+
+    **Using Managed Identities over app registrations is highly recommended!**
+
+    If your machine resides outside of Azure, please make sure the machine is onboarded into Azure Arc. [Learn more about Azure Arc](<https://learn.microsoft.com/en-us/azure/azure-arc/servers/overview#next-steps>)
+- **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 to the Microsoft Entra ID 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.
+
+Here is an example for the output plugin configuration section using a Managed Identity:
+
+```
+output {
+    microsoft-sentinel-log-analytics-logstash-output-plugin {
+        managed_identity => true
+        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>"
+    }
+}
+```
+
+#### 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"
+	}
+]
+```

data/code_of_conduct.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/lib/logstash/outputs/microsoft-sentinel-log-analytics-logstash-output-plugin.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/sentinel_la/logstashLoganalyticsConfiguration"
+require "logstash/sentinel_la/sampleFileCreator"
+require "logstash/sentinel_la/logsSender"
+
+
+class LogStash::Outputs::MicrosoftSentinelOutput < LogStash::Outputs::Base
+
+  config_name "microsoft-sentinel-log-analytics-logstash-output-plugin"
+
+  # Stating that the output plugin will run in concurrent mode
+  concurrency :shared
+
+  # If managed Identity is used, the plugin will use the managed identity to authenticate with Microsoft Entra ID
+  config :managed_identity, :validate => :boolean, :default => false
+
+  # Your registered app ID
+  config :client_app_Id, :validate => :string
+
+  # The registered app's secret, required by Azure Loganalytics REST API
+  config :client_app_secret, :validate => :string
+
+  # Your Operations Management Suite Tenant ID
+  config :tenant_id, :validate => :string
+
+  # Your data collection rule endpoint
+  config :data_collection_endpoint, :validate => :string
+
+  # Your data collection rule ID
+  config :dcr_immutable_id, :validate => :string
+
+  # Your dcr data stream name
+  config :dcr_stream_name, :validate => :string
+
+  # Subset of keys to send to the Azure Loganalytics workspace
+  config :key_names, :validate => :array, :default => []
+
+  # Max number of seconds to wait between flushes. Default 5
+  config :plugin_flush_interval, :validate => :number, :default => 5
+
+  # Factor for adding to the amount of messages sent
+  config :decrease_factor, :validate => :number, :default => 100
+
+  # This will trigger message amount resizing in a REST request to LA
+  config :amount_resizing, :validate => :boolean, :default => true
+
+  # Setting the default amount of messages sent
+  # it this is set with amount_resizing=false --> each message will have max_items
+  config :max_items, :validate => :number, :default => 2000
+
+  # Setting default proxy to be used for all communication with azure
+  config :proxy, :validate => :string
+
+  # Setting proxy_aad to be used for communicating with the Microsoft Entra ID service
+  config :proxy_aad, :validate => :string
+
+  # Setting proxy to be used for the LogAnalytics endpoint REST client
+  config :proxy_endpoint, :validate => :string
+
+  # This will set the amount of time given for retransmitting messages once sending is failed
+  config :retransmission_time, :validate => :number, :default => 10
+
+  # Compress the message body before sending to LA
+  config :compress_data, :validate => :boolean, :default => false
+
+  # Generate sample file from incoming events
+  config :create_sample_file, :validate => :boolean, :default => false
+
+  # Path where to place the sample file created
+  config :sample_file_path, :validate => :string
+
+  # Used to specify the name of the Azure cloud that is being used. By default, the value is set to "AzureCloud", which
+  # is the public Azure cloud. However, you can specify a different Azure cloud if you are
+  # using a different environment, such as Azure Government or Azure China.
+  config :azure_cloud, :validate => :string
+
+  public
+  def register
+    @logstash_configuration= build_logstash_configuration()
+
+    # Validate configuration correctness
+    @logstash_configuration.validate_configuration()
+
+    @events_handler = @logstash_configuration.create_sample_file ?
+                        LogStash::Outputs::MicrosoftSentinelOutputInternal::SampleFileCreator::new(@logstash_configuration) :
+                        LogStash::Outputs::MicrosoftSentinelOutputInternal::LogsSender::new(@logstash_configuration)
+  end # def register
+
+  def multi_receive(events)
+    @events_handler.handle_events(events)
+  end # def multi_receive
+
+  def close
+    @events_handler.close
+  end
+
+  #private
+  private
+
+  # Building the logstash object configuration from the output configuration provided by the user
+  # Return LogstashLoganalyticsOutputConfiguration populated with the configuration values
+  def build_logstash_configuration()
+    logstash_configuration= LogStash::Outputs::MicrosoftSentinelOutputInternal::LogstashLoganalyticsOutputConfiguration::new(@client_app_Id, @client_app_secret, @tenant_id, @data_collection_endpoint, @dcr_immutable_id, @dcr_stream_name, @compress_data, @create_sample_file, @sample_file_path, @logger, @managed_identity)
+    logstash_configuration.key_names = @key_names
+    logstash_configuration.plugin_flush_interval = @plugin_flush_interval
+    logstash_configuration.decrease_factor = @decrease_factor
+    logstash_configuration.amount_resizing = @amount_resizing
+    logstash_configuration.max_items = @max_items
+    logstash_configuration.proxy_aad = @proxy_aad || @proxy || ENV['http_proxy']
+    logstash_configuration.proxy_endpoint = @proxy_endpoint || @proxy || ENV['http_proxy']
+    logstash_configuration.retransmission_time = @retransmission_time
+    logstash_configuration.azure_cloud = @azure_cloud || "AzureCloud"
+
+    return logstash_configuration
+  end # def build_logstash_configuration
+
+end # class LogStash::Outputs::MicrosoftSentinelOutput