Merge 761e55cd08 into 84b5d38c51

.github/BOTMETA.yml

@@ -65,6 +65,8 @@ files:
   $callbacks/log_plays.py: {}
   $callbacks/loganalytics.py:
     maintainers: zhcli
+  $callbacks/loganalytics_ingestion.py:
+    maintainers: pboushy vsh47 wtcline-intc
   $callbacks/logdna.py: {}
   $callbacks/logentries.py: {}
   $callbacks/logstash.py:

plugins/callback/loganalytics.py

@@ -15,6 +15,7 @@ description:
   - Credits to authors of splunk callback plugin.
 version_added: "2.4.0"
 requirements:
+  - The Python 'requests' module.
   - Whitelisting this callback plugin.
   - An Azure log analytics work space has been established.
 options:

plugins/callback/loganalytics_ingestion.py

@@ -0,0 +1,346 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright: Contributors to the Ansible project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+DOCUMENTATION = '''
+    name: loganalytics_ingestion
+    type: notification
+    short_description: Posts task results to an Azure Log Analytics workspace using the new Logs Ingestion API
+    author:
+      - Wade Cline (@wtcline-intc) <wade.cline@intel.com>
+      - Sriramoju Vishal Bharath (@sriramoj) <sriramoju.vishal.bharath@intel.com>
+      - Cyrus Li (@zhcli) <cyrus1006@gmail.com>
+    description:
+      - This callback plugin will post task results in JSON format to an Azure Log Analytics workspace using the new Logs Ingestion API.
+    version_added: "10.7.0"
+    requirements:
+      - The callback plugin has been enabled
+      - an Azure Log Analytics workspace has been established
+      - a Data Collection Rule (DCR) and custom table are created
+    options:
+      dce_url:
+        description: URL of the Data Collection Endpoint (DCE) for Azure Logs Ingestion API.
+        type: str
+        required: true
+        env:
+          - name: LOGANALYTICS_DCE_URL
+        ini:
+          - section: callback_loganalytics
+            key: dce_url
+      dcr_id:
+        description: Data Collection Rule (DCR) ID for the Azure Log Ingestion API.
+        type: str
+        required: true
+        env:
+          - name: LOGANALYTICS_DCR_ID
+        ini:
+          - section: callback_loganalytics
+            key: dcr_id
+      disable_attempts:
+        description:
+          - When O(disable_on_failure=true), number of module failures that must occur before the module is disabled.
+          - This helps prevent outright module failure from a single, transient network issue.
+        type: int
+        required: false
+        default: 3
+        env:
+          - name: LOGANALYTICS_DISABLE_ATTEMPTS
+        ini:
+          - section: callback_loganalytics
+            key: disable_attempts
+      disable_on_failure:
+        description: Stop trying to send data on module failure.
+        type: bool
+        required: false
+        default: true
+        env:
+          - name: LOGANALYTICS_DISABLE_ON_FAILURE
+        ini:
+          - section: callback_loganalytics
+            key: disable_on_failure
+      client_id:
+        description: Client ID of the Azure App registration for OAuth2 authentication ("Modern Authentication").
+        type: str
+        required: true
+        env:
+          - name: LOGANALYTICS_CLIENT_ID
+        ini:
+          - section: callback_loganalytics
+            key: client_id
+      client_secret:
+        description: Client Secret of the Azure App registration.
+        type: str
+        required: true
+        env:
+          - name: LOGANALYTICS_CLIENT_SECRET
+        ini:
+          - section: callback_loganalytics
+            key: client_secret
+      include_content:
+        description: Send the content to the Azure Log Analytics workspace.
+        type: bool
+        required: false
+        default: false
+        env:
+          - name: LOGANALYTICS_INCLUDE_CONTENT
+        ini:
+          - section: callback_loganalytics
+            key: include_content
+      include_task_args:
+        description: Send the task args to the Azure Log Analytics workspace.
+        type: bool
+        required: false
+        default: false
+        env:
+          - name: LOGANALYTICS_INCLUDE_TASK_ARGS
+        ini:
+          - section: callback_loganalytics
+            key: include_task_args
+      stream_name:
+        description: The name of the stream used to send the logs to the Azure Log Analytics workspace.
+        type: str
+        required: true
+        env:
+          - name: LOGANALYTICS_STREAM_NAME
+        ini:
+          - section: callback_loganalytics
+            key: stream_name
+      tenant_id:
+        description: Tenant ID for the Azure Active Directory.
+        type: str
+        required: true
+        env:
+          - name: LOGANALYTICS_TENANT_ID
+        ini:
+          - section: callback_loganalytics
+            key: tenant_id
+      timeout:
+        description: Timeout for the HTTP requests to the Azure Log Analytics API.
+        type: int
+        required: false
+        default: 2
+        env:
+          - name: LOGANALYTICS_TIMEOUT
+        ini:
+          - section: callback_loganalytics
+            key: timeout
+    seealso:
+      - name: Logs Ingestion API
+        description: Overview of Logs Ingestion API in Azure Monitor
+        link: https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview
+'''
+
+EXAMPLES = '''
+examples: |
+  Enable the plugin in ansible.cfg:
+    [defaults]
+    callback_enabled = community.general.loganalytics_ingestion
+  Set the environment variables:
+    export LOGANALYTICS_DCE_URL=https://my-dce.ingest.monitor.azure.com
+    export LOGANALYTICS_DCR_ID=dcr-xxxxxx
+    export LOGANALYTICS_CLIENT_ID=xxxxxxxx
+    export LOGANALYTICS_CLIENT_SECRET=xxxxxxxx
+    export LOGANALYTICS_TENANT_ID=xxxxxxxx
+    export LOGANALYTICS_STREAM_NAME=Custom-MyTable
+'''
+
+import getpass
+import json
+try:
+    import requests
+except ImportError as exception:
+    IMPORT_ERROR_REQUESTS = exception
+else:
+    IMPORT_ERROR_REQUESTS = None
+import socket
+import uuid
+from datetime import datetime, timezone, timedelta
+from os.path import basename
+
+from ansible.plugins.callback import CallbackBase
+from ansible.errors import AnsibleError
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class AzureLogAnalyticsIngestionSource(object):
+    def __init__(self, dce_url, dcr_id, disable_attempts, disable_on_failure, client_id, client_secret, tenant_id, stream_name, include_task_args,
+                 include_content, timeout):
+        self.dce_url = dce_url
+        self.dcr_id = dcr_id
+        self.disabled = False
+        self.disable_attempts = disable_attempts
+        self.disable_on_failure = disable_on_failure
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.failures = 0
+        self.tenant_id = tenant_id
+        self.stream_name = stream_name
+        self.include_task_args = include_task_args
+        self.include_content = include_content
+        self.token_expiration_time = None
+        self.requests_session = requests.Session()
+        self.session = str(uuid.uuid4())
+        self.host = socket.gethostname()
+        self.user = getpass.getuser()
+        self.timeout = timeout
+
+        self.bearer_token = self.get_bearer_token()
+
+    # OAuth2 authentication method to get a Bearer token
+    # This replaces the shared_key authentication mechanism
+    def get_bearer_token(self):
+        url = f"https://login.microsoftonline.com/{self.tenant_id}/oauth2/v2.0/token"
+        payload = {
+            'grant_type': 'client_credentials',
+            'client_id': self.client_id,
+            'client_secret': self.client_secret,
+            # The scope value comes from https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview#headers
+            # and https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc#the-default-scope
+            'scope': 'https://monitor.azure.com/.default'
+        }
+        response = self.requests_session.post(url, data=payload, timeout=self.timeout)
+        response.raise_for_status()
+        self.token_expiration_time = datetime.now() + timedelta(seconds=response.json().get("expires_in"))
+        return response.json().get('access_token')
+
+    def is_token_valid(self):
+        return True if (datetime.now() + timedelta(seconds=10)) < self.token_expiration_time else False
+
+    # Method to send event data to the Azure Logs Ingestion API
+    # This replaces the legacy API call and now uses the Logs Ingestion API endpoint
+    def send_event(self, event_data):
+        if not self.is_token_valid():
+            self.bearer_token = self.get_bearer_token()
+        ingestion_url = f"{self.dce_url}/dataCollectionRules/{self.dcr_id}/streams/{self.stream_name}?api-version=2023-01-01"
+        headers = {
+            'Authorization': f"Bearer {self.bearer_token}",
+            'Content-Type': 'application/json'
+        }
+        response = self.requests_session.post(ingestion_url, headers=headers, json=event_data, timeout=self.timeout)
+        response.raise_for_status()
+
+    def _rfc1123date(self):
+        return datetime.now(timezone.utc).strftime('%a, %d %b %Y %H:%M:%S GMT')
+
+    # This method wraps the private method with the appropriate error handling.
+    def send_to_loganalytics(self, playbook_name, result, state):
+        if self.disabled:
+            return
+        try:
+            self._send_to_loganalytics(playbook_name, result, state)
+        except Exception as e:
+            display.warning(f"LogAnalytics Ingestion callback module failure: {e}.")
+            if self.disable_on_failure:
+                self.failures += 1
+                if self.failures >= self.disable_attempts:
+                    display.warning(f"LogAnalytics module failures exceed maximum of '{self.disable_attempts}'!  Disabling module!")
+                    self.disabled = True
+                else:
+                    display.v(f"LogAnalytics module failure {self.failures}/{self.disable_attempts}")
+
+    def _send_to_loganalytics(self, playbook_name, result, state):
+        ansible_check_mode = None
+        if result._task_fields['args'].get('_ansible_check_mode') is True:
+            ansible_check_mode = True
+
+        ansible_version = None
+        if result._task_fields['args'].get('_ansible_version'):
+            ansible_version = result._task_fields['args'].get('_ansible_version')
+
+        ansible_role = None
+        if result._task._role:
+            ansible_role = str(result._task._role)
+
+        # Include/Exclude task args
+        if not self.include_task_args:
+            result._task_fields.pop('args', None)
+
+        # Include/Exclude content
+        if not self.include_content:
+            result._result.pop('content', None)
+
+        # Build the event data
+        event_data = [{
+            "TimeGenerated": self._rfc1123date(),
+            "Host": result._host.name,
+            "User": self.user,
+            "Playbook": playbook_name,
+            "Role": ansible_role,
+            "TaskName": result._task.get_name(),
+            "Task": result._task_fields,
+            "Action": result._task_fields['action'],
+            "State": state,
+            "Result": result._result,
+            "Session": self.session
+        }]
+
+        # Display event data
+        # The data displayed here can be used as a sample file in order to create the table's schema.
+        display.vvv(f"Event Data: {json.dumps(event_data)}")
+
+        # Send the event data using the new Logs Ingestion API method
+        self.send_event(event_data)
+
+
+class CallbackModule(CallbackBase):
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'notification'
+    CALLBACK_NAME = 'loganalytics_ingestion'
+    CALLBACK_NEEDS_ENABLED = True
+
+    def __init__(self, display=None):
+        if IMPORT_ERROR_REQUESTS:
+            raise AnsibleError("'requests' must be installed in order to use this plugin") from IMPORT_ERROR_REQUESTS
+        super(CallbackModule, self).__init__(display=display)
+        self.start_datetimes = {}
+        self.playbook_name = None
+        self.azure_loganalytics = None
+
+    def set_options(self, task_keys=None, var_options=None, direct=None):
+        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
+
+        # Set options for the new Azure Logs Ingestion API configuration
+        self.client_id = self.get_option('client_id')
+        self.client_secret = self.get_option('client_secret')
+        self.dce_url = self.get_option('dce_url')
+        self.dcr_id = self.get_option('dcr_id')
+        self.disable_attempts = self.get_option('disable_attempts')
+        self.disable_on_failure = self.get_option('disable_on_failure')
+        self.include_content = self.get_option('include_content')
+        self.include_task_args = self.get_option('include_task_args')
+        self.stream_name = self.get_option('stream_name')
+        self.tenant_id = self.get_option('tenant_id')
+        self.timeout = self.get_option('timeout')
+        self.validate_inputs()
+
+        # Initialize the AzureLogAnalyticsIngestionSource with the new settings
+        self.azure_loganalytics = AzureLogAnalyticsIngestionSource(
+            self.dce_url, self.dcr_id, self.disable_attempts, self.disable_on_failure, self.client_id, self.client_secret, self.tenant_id, self.stream_name,
+            self.include_task_args, self.include_content, self.timeout
+        )
+
+    # Input checks
+    def validate_inputs(self):
+        # Type checks
+        boolean_checks = [
+            (self.include_task_args, "INCLUDE_TASK_ARGS must be true or false"),
+            (self.include_content, "INCLUDE_CONTENT must be true or false")
+        ]
+        for attribute, message in boolean_checks:
+            if not isinstance(attribute, bool):
+                Display().warning(message)
+
+    def v2_playbook_on_start(self, playbook):
+        self.playbook_name = basename(playbook._file_name)
+
+    # Build event data and send it to the Logs Ingestion API
+    def v2_runner_on_failed(self, result, **kwargs):
+        self.azure_loganalytics.send_to_loganalytics(self.playbook_name, result, "FAILED")
+
+    def v2_runner_on_ok(self, result, **kwargs):
+        self.azure_loganalytics.send_to_loganalytics(self.playbook_name, result, "OK")

tests/unit/plugins/callback/test_loganalytics_ingestion.py

@@ -0,0 +1,58 @@
+# Copyright (c) Ansible project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import time
+import unittest
+import unittest.mock
+import urllib
+
+from ansible_collections.community.general.plugins.callback.loganalytics_ingestion import AzureLogAnalyticsIngestionSource
+
+
+class TestAzureLogAnalyticsIngestion(unittest.TestCase):
+    dce_url = "https://fake.dce_url.ansible.com"
+    dcr_id = "fake-dcr-id"
+    client_id = "fake-client_id"
+    client_secret = "fake-client-secret"
+    tenant_id = "fake-tenant-id"
+    stream_name = "fake-stream-name"
+
+    @unittest.mock.patch("ansible_collections.community.general.plugins.callback.loganalytics_ingestion.requests.Session", autospec=True)
+    @unittest.mock.patch("ansible_collections.community.general.plugins.callback.loganalytics_ingestion.requests.Response", autospec=True)
+    def setUp(self, ResponseMock, SessionMock):
+        # Generate a fake access token.
+        response_mock = ResponseMock()
+        response_mock.json.return_value = {"expires_in": time.time() + 3600, "access_token": "fake_access_token"}
+        SessionMock.return_value.post.return_value = response_mock
+
+        # TODO: How to set module default arguments?
+        #       I tried instantiating the 'CallbackModule' but all it ever did was complain that 'client_id' wasn't defined.
+        self.loganalytics = AzureLogAnalyticsIngestionSource(
+            self.dce_url, self.dcr_id, 3, True,
+            self.client_id, self.client_secret, self.tenant_id,
+            self.stream_name, False, False, 2
+        )
+
+    @unittest.mock.patch("json.dumps")
+    @unittest.mock.patch("ansible.executor.task_result.TaskResult")
+    def test_sending_data(self, MockTaskResult, MockJsonDumps):
+        """
+        Tests sending data by verifying that the expected POST requests are submitted to the expected hosts.
+        """
+        # Neither the Mock objects nor its attributes are serializable but we don't care about getting accurate JSON in this case so just return fake JSON data.
+        MockJsonDumps.return_value = '{"name": "fake_json"}'
+
+        self.loganalytics.send_to_loganalytics("fake_playbook", MockTaskResult(), "OK")
+        self.loganalytics.send_to_loganalytics("fake_playbook", MockTaskResult(), "FAILED")
+        self.loganalytics.send_to_loganalytics("fake_playbook", MockTaskResult(), "OK")
+
+        # One POST request for authentication, three POST requests for sending data (one for each task).
+        assert self.loganalytics.requests_session.post.call_count == 4
+        # First POST request for login.
+        url = urllib.parse.urlparse(self.loganalytics.requests_session.post.call_args_list[0][0][0])
+        assert url.netloc == "login.microsoftonline.com"
+        # Three POST requests to the DCE.
+        for i in range(1, 3):
+            url = urllib.parse.urlparse(self.loganalytics.requests_session.post.call_args_list[i][0][0])
+            assert url.scheme + "://" + url.netloc == self.dce_url