Merge pull request #512 from NHSDigital/dtoss-11201-setup-application-insights

DTOSS-11201: Setup Application Insights

Author: Harriethw

Dockerfile

@@ -20,7 +20,7 @@ ARG poetry_version
 
 WORKDIR /app
 
-RUN apk add --no-cache libgcc libstdc++ build-base
+RUN apk add --no-cache libgcc libstdc++ build-base linux-headers
 
 # Set environment variables
 ENV PYTHONDONTWRITEBYTECODE=1

manage_breast_screening/config/.env.tpl

@@ -45,3 +45,8 @@ QUEUE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=http;AccountName=devst
 REPORTS_CONTAINER_NAME="notifications-reports"
 RETRY_QUEUE_NAME="notifications-message-batch-retries"
 STATUS_UPDATES_QUEUE_NAME="notifications-message-status-updates"
+
+APPLICATIONINSIGHTS_CONNECTION_STRING=""
+APPLICATIONINSIGHTS_STATSBEAT_DISABLED_ALL=True
+APPLICATIONINSIGHTS_LOGGER_NAME="manbrs-notifications"
+APPLICATIONINSIGHTS_IS_ENABLED=False

manage_breast_screening/notifications/apps.py

@@ -1,6 +1,14 @@
 from django.apps import AppConfig
 
+from manage_breast_screening.notifications.services.application_insights_logging import (
+    ApplicationInsightsLogging,
+)
+
 
 class NotificationsConfig(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
     name = "manage_breast_screening.notifications"
+
+    def ready(self) -> None:
+        ApplicationInsightsLogging().configure_azure_monitor()
+        return super().ready()

manage_breast_screening/notifications/management/commands/retry_failed_message_batch.py

@@ -12,9 +12,13 @@
     MessageBatchStatusChoices,
 )
 from manage_breast_screening.notifications.services.api_client import ApiClient
+from manage_breast_screening.notifications.services.application_insights_logging import (
+    ApplicationInsightsLogging,
+)
 from manage_breast_screening.notifications.services.queue import Queue
 
 logger = getLogger(__name__)
+INSIGHTS_ERROR_NAME = "RetryFailedMessageBatchError"
 
 
 class Command(BaseCommand):
@@ -24,6 +28,13 @@ class Command(BaseCommand):
     """
 
     def handle(self, *args, **options):
+        try:
+            self.retry_failed_message_batch()
+        except Exception as e:
+            ApplicationInsightsLogging().exception(f"{INSIGHTS_ERROR_NAME}: {e}")
+            raise CommandError(e)
+
+    def retry_failed_message_batch(self):
         logger.info("Retry Failed Message Batch Command started")
         queue = Queue.RetryMessageBatches()
         queue_message = queue.item()
@@ -57,22 +68,18 @@ def handle(self, *args, **options):
                 retry_count,
             )
 
-            try:
-                response = ApiClient().send_message_batch(message_batch)
-
-                if response.status_code == 201:
-                    MessageBatchHelpers.mark_batch_as_sent(
-                        message_batch=message_batch, response_json=response.json()
-                    )
-                else:
-                    MessageBatchHelpers.mark_batch_as_failed(
-                        message_batch=message_batch,
-                        response=response,
-                        retry_count=(retry_count + 1),
-                    )
+            response = ApiClient().send_message_batch(message_batch)
 
-            except Exception as e:
-                raise CommandError(e)
+            if response.status_code == 201:
+                MessageBatchHelpers.mark_batch_as_sent(
+                    message_batch=message_batch, response_json=response.json()
+                )
+            else:
+                MessageBatchHelpers.mark_batch_as_failed(
+                    message_batch=message_batch,
+                    response=response,
+                    retry_count=(retry_count + 1),
+                )
         else:
             logger.error(
                 "Failed Message Batch with id %s not sent: Retry limit exceeded",

manage_breast_screening/notifications/services/application_insights_logging.py

@@ -0,0 +1,39 @@
+import logging
+import os
+
+from azure.monitor.opentelemetry import configure_azure_monitor
+
+
+class ApplicationInsightsLogging:
+    def __init__(self) -> None:
+        self.logger_name = os.getenv(
+            "APPLICATIONINSIGHTS_LOGGER_NAME", "manbrs-notifications"
+        )
+        self.logger = self.getLogger()
+
+    def configure_azure_monitor(self):
+        if os.getenv("APPLICATIONINSIGHTS_IS_ENABLED", "False") == "True":
+            # Configure OpenTelemetry to use Azure Monitor with the
+            # APPLICATIONINSIGHTS_CONNECTION_STRING environment variable.
+            configure_azure_monitor(
+                # Set the namespace for the logger in which you would like to collect telemetry for if you are collecting logging telemetry. This is imperative so you do not collect logging telemetry from the SDK itself.
+                logger_name=self.logger_name,
+            )
+        else:
+            default_logger = logging.getLogger(__name__)
+            default_logger.info("Application Insights logging not enabled")
+
+    def getLogger(self):
+        return logging.getLogger(self.logger_name)
+
+    def exception(self, exception_name: str):
+        self.logger.exception(exception_name, stack_info=True)
+
+    def custom_event(self, event_name: str, additional_attrs: str | None = None):
+        self.logger.warning(
+            event_name,
+            extra={
+                "microsoft.custom_event.name": event_name,
+                "additional_attrs": additional_attrs,
+            },
+        )

manage_breast_screening/notifications/tests/integration/test_retry_message_batches_from_queue.py

@@ -30,6 +30,7 @@ def setup(self, monkeypatch):
         monkeypatch.setenv("API_OAUTH_API_KEY", "a1b2c3d4")
         monkeypatch.setenv("API_OAUTH_API_KID", "test-1")
         monkeypatch.setenv("API_OAUTH_PRIVATE_KEY", "test-key")
+        monkeypatch.setenv("APPLICATIONINSIGHTS_IS_ENABLED", "False")
 
     @pytest.fixture
     def routing_plan_id(self):

manage_breast_screening/notifications/tests/management/commands/test_retry_failed_message_batch.py

@@ -13,6 +13,9 @@
     CommandError,
 )
 from manage_breast_screening.notifications.services.api_client import ApiClient
+from manage_breast_screening.notifications.services.application_insights_logging import (
+    ApplicationInsightsLogging,
+)
 from manage_breast_screening.notifications.services.queue import Queue
 from manage_breast_screening.notifications.tests.factories import MessageBatchFactory
 
@@ -30,6 +33,14 @@ def setup(monkeypatch):
 @patch.object(MessageBatchHelpers, "mark_batch_as_sent")
 @patch.object(MessageBatchHelpers, "mark_batch_as_failed")
 class TestRetryFailedMessageBatch:
+    @pytest.fixture(autouse=True)
+    def mock_insights_logger(self, monkeypatch):
+        mock_insights_logger = MagicMock()
+        monkeypatch.setattr(
+            ApplicationInsightsLogging, "exception", mock_insights_logger
+        )
+        return mock_insights_logger
+
     @pytest.mark.django_db
     def test_handle_batch_not_found(
         self,
@@ -170,3 +181,27 @@ def test_batch_with_retry_count_more_than_5_is_marked_as_failed_unrecoverable(
             str(error.value)
             == f"Message Batch with id {batch_id} not sent: Retry limit exceeded"
         )
+
+    @pytest.mark.django_db
+    def test_calls_insights_logger_if_exception_raised(
+        self,
+        mock_mark_batch_as_failed,
+        mock_mark_batch_as_sent,
+        mock_retry_message_batches,
+        mock_send_message_batch,
+        mock_insights_logger,
+    ):
+        subject = Command()
+        batch_id = uuid.uuid4()
+        _failed_batch = MessageBatchFactory(id=batch_id, status="failed_recoverable")
+
+        mock_retry_message_batches.return_value.item.return_value.content = json.dumps(
+            {"message_batch_id": str(batch_id), "retry_count": 5}
+        )
+
+        with pytest.raises(CommandError):
+            subject.handle()
+
+        mock_insights_logger.assert_called_with(
+            f"RetryFailedMessageBatchError: Message Batch with id {str(batch_id)} not sent: Retry limit exceeded"
+        )

manage_breast_screening/notifications/tests/services/test_application_insights_logging.py

@@ -0,0 +1,49 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from manage_breast_screening.notifications.services.application_insights_logging import (
+    ApplicationInsightsLogging,
+)
+
+
+@patch(
+    "manage_breast_screening.notifications.services.application_insights_logging.configure_azure_monitor",
+    return_value=MagicMock(),
+)
+@patch(
+    "manage_breast_screening.notifications.services.application_insights_logging.logging"
+)
+class TestApplicationInsightsLogging:
+    @pytest.fixture(autouse=True)
+    def setup(self, monkeypatch):
+        monkeypatch.setenv("APPLICATIONINSIGHTS_LOGGER_NAME", "insights-logger")
+
+    def test_configure_azure_monitor(
+        self, mock_logging, mock_configure_azure, monkeypatch
+    ):
+        monkeypatch.setenv("APPLICATIONINSIGHTS_IS_ENABLED", "True")
+        ApplicationInsightsLogging().configure_azure_monitor()
+        mock_configure_azure.assert_called_with(logger_name="insights-logger")
+
+    def test_getLogger(self, mock_logging, mock_configure_azure):
+        ApplicationInsightsLogging().getLogger()
+        mock_logging.getLogger.assert_called_with("insights-logger")
+
+    def test_raise_exception(self, mock_logging, mock_configure_azure):
+        ApplicationInsightsLogging().exception("CustomError")
+        mock_logging.getLogger.assert_called_with("insights-logger")
+        mock_logging.getLogger.return_value.exception.assert_called_with(
+            "CustomError", stack_info=True
+        )
+
+    def test_trigger_an_event(self, mock_logging, mock_configure_azure):
+        ApplicationInsightsLogging().custom_event("CustomEvent", "something went wrong")
+        mock_logging.getLogger.assert_called_with("insights-logger")
+        mock_logging.getLogger.return_value.warning.assert_called_with(
+            "CustomEvent",
+            extra={
+                "microsoft.custom_event.name": "CustomEvent",
+                "additional_attrs": "something went wrong",
+            },
+        )