Merge pull request #745 from NHSDigital/DTOSS-11680-completed-event

DTOSS-11680: Standardise completed logging for Commands

Author: Harriethw

manage_breast_screening/notifications/management/commands/create_appointments.py

@@ -6,8 +6,8 @@
 import pandas
 from django.core.management.base import BaseCommand
 
-from manage_breast_screening.notifications.management.commands.helpers.exception_handler import (
-    exception_handler,
+from manage_breast_screening.notifications.management.commands.helpers.command_handler import (
+    CommandHandler,
 )
 from manage_breast_screening.notifications.models import (
     ZONE_INFO,
@@ -18,7 +18,7 @@
 from manage_breast_screening.notifications.services.blob_storage import BlobStorage
 
 DIR_NAME_DATE_FORMAT = "%Y-%m-%d"
-INSIGHTS_ERROR_NAME = "CreateAppointmentsError"
+INSIGHTS_JOB_NAME = "CreateAppointments"
 logger = getLogger(__name__)
 
 
@@ -37,7 +37,7 @@ def add_arguments(self, parser):
         )
 
     def handle(self, *args, **options):
-        with exception_handler(INSIGHTS_ERROR_NAME):
+        with CommandHandler.handle(INSIGHTS_JOB_NAME):
             logger.info("Create Appointments command started")
             container_client = BlobStorage().find_or_create_container(
                 os.getenv("BLOB_CONTAINER_NAME", "")
@@ -63,7 +63,6 @@ def handle(self, *args, **options):
                             row, clinic
                         )
                 logger.info("Processed %s rows from %s", len(data_frame), blob.name)
-            logger.info("Create Appointments command finished successfully")
 
     def is_not_holding_clinic(self, row):
         return row.get("Holding Clinic") != "Y"

manage_breast_screening/notifications/management/commands/create_reports.py

@@ -5,16 +5,16 @@
 from django.core.management.base import BaseCommand
 from django.db import connection
 
-from manage_breast_screening.notifications.management.commands.helpers.exception_handler import (
-    exception_handler,
+from manage_breast_screening.notifications.management.commands.helpers.command_handler import (
+    CommandHandler,
 )
 from manage_breast_screening.notifications.models import ZONE_INFO
 from manage_breast_screening.notifications.queries.helper import Helper
 from manage_breast_screening.notifications.services.blob_storage import BlobStorage
 from manage_breast_screening.notifications.services.nhs_mail import NhsMail
 
 logger = getLogger(__name__)
-INSIGHTS_ERROR_NAME = "CreateReportsError"
+INSIGHTS_JOB_NAME = "CreateReports"
 
 
 class ReportConfig:
@@ -58,7 +58,7 @@ def add_arguments(self, parser):
         parser.add_argument("--smoke-test", action="store_true")
 
     def handle(self, *args, **options):
-        with exception_handler(INSIGHTS_ERROR_NAME):
+        with CommandHandler.handle(INSIGHTS_JOB_NAME):
             logger.info("Create Report Command started")
 
             bso_codes, report_configs = self.configuration(options)
@@ -86,8 +86,6 @@ def handle(self, *args, **options):
                 NhsMail().send_reports_email(external_reports)
                 logger.info(f"Reports sent: {', '.join(external_reports.keys())}")
 
-            logger.info("Create Report Command finished")
-
     def configuration(self, options: dict) -> tuple[list[str], list[ReportConfig]]:
         if options.get("smoke_test", False):
             bso_codes = [self.SMOKE_TEST_BSO_CODE]

manage_breast_screening/notifications/management/commands/helpers/command_handler.py

@@ -0,0 +1,22 @@
+from contextlib import contextmanager
+
+from django.core.management.base import CommandError
+
+from manage_breast_screening.notifications.services.application_insights_logging import (
+    ApplicationInsightsLogging,
+)
+
+
+class CommandHandler:
+    @contextmanager
+    @staticmethod
+    def handle(command_name):
+        try:
+            yield
+            ApplicationInsightsLogging().custom_event_info(
+                event_name=f"{command_name}Completed",
+                message=f"{command_name} completed successfully",
+            )
+        except Exception as e:
+            ApplicationInsightsLogging().exception(f"{command_name}Error: {e}")
+            raise CommandError(e)

manage_breast_screening/notifications/management/commands/helpers/exception_handler.py

@@ -61,7 +61,7 @@ def mark_batch_as_failed(
             response.status_code,
             response.text,
         )
-        ApplicationInsightsLogging().custom_event(
+        ApplicationInsightsLogging().custom_event_warning(
             message=log_msg,
             event_name="batch_marked_as_failed",
         )

manage_breast_screening/notifications/management/commands/helpers/message_batch_helpers.py

@@ -4,8 +4,8 @@
 
 from django.core.management.base import BaseCommand, CommandError
 
-from manage_breast_screening.notifications.management.commands.helpers.exception_handler import (
-    exception_handler,
+from manage_breast_screening.notifications.management.commands.helpers.command_handler import (
+    CommandHandler,
 )
 from manage_breast_screening.notifications.management.commands.helpers.message_batch_helpers import (
     MessageBatchHelpers,
@@ -18,7 +18,7 @@
 from manage_breast_screening.notifications.services.queue import Queue
 
 logger = getLogger(__name__)
-INSIGHTS_ERROR_NAME = "RetryFailedMessageBatchError"
+INSIGHTS_JOB_NAME = "RetryFailedMessageBatch"
 
 
 class Command(BaseCommand):
@@ -28,7 +28,7 @@ class Command(BaseCommand):
     """
 
     def handle(self, *args, **options):
-        with exception_handler(INSIGHTS_ERROR_NAME):
+        with CommandHandler.handle(INSIGHTS_JOB_NAME):
             logger.info("Retry Failed Message Batch Command started")
             queue = Queue.RetryMessageBatches()
             logger.debug("Retry queue items: %s", queue.peek())

manage_breast_screening/notifications/management/commands/retry_failed_message_batch.py

@@ -5,8 +5,8 @@
 from django.core.exceptions import ValidationError
 from django.core.management.base import BaseCommand
 
-from manage_breast_screening.notifications.management.commands.helpers.exception_handler import (
-    exception_handler,
+from manage_breast_screening.notifications.management.commands.helpers.command_handler import (
+    CommandHandler,
 )
 from manage_breast_screening.notifications.models import (
     ChannelStatus,
@@ -15,7 +15,7 @@
 )
 from manage_breast_screening.notifications.services.queue import Queue
 
-INSIGHTS_ERROR_NAME = "SaveMessageStatusError"
+INSIGHTS_JOB_NAME = "SaveMessageStatus"
 logger = getLogger(__name__)
 
 
@@ -26,7 +26,7 @@ class Command(BaseCommand):
     """
 
     def handle(self, *args, **options):
-        with exception_handler(INSIGHTS_ERROR_NAME):
+        with CommandHandler.handle(INSIGHTS_JOB_NAME):
             logger.info("Save Message Status Command started")
             queue = Queue.MessageStatusUpdates()
             for item in queue.items():

manage_breast_screening/notifications/management/commands/save_message_status.py

@@ -2,8 +2,11 @@
 from logging import getLogger
 
 from business.calendar import Calendar
-from django.core.management.base import BaseCommand, CommandError
+from django.core.management.base import BaseCommand
 
+from manage_breast_screening.notifications.management.commands.helpers.command_handler import (
+    CommandHandler,
+)
 from manage_breast_screening.notifications.management.commands.helpers.message_batch_helpers import (
     MessageBatchHelpers,
 )
@@ -18,11 +21,8 @@
     MessageBatchStatusChoices,
 )
 from manage_breast_screening.notifications.services.api_client import ApiClient
-from manage_breast_screening.notifications.services.application_insights_logging import (
-    ApplicationInsightsLogging,
-)
 
-INSIGHTS_ERROR_NAME = "SendMessageBatchError"
+INSIGHTS_JOB_NAME = "SendMessageBatch"
 logger = getLogger(__name__)
 
 
@@ -33,11 +33,8 @@ class Command(BaseCommand):
     """
 
     def handle(self, *args, **options):
-        try:
+        with CommandHandler.handle(INSIGHTS_JOB_NAME):
             return self.send_message_batch()
-        except Exception as e:
-            ApplicationInsightsLogging().exception(f"{INSIGHTS_ERROR_NAME}: {e}")
-            raise CommandError(e)
 
     def send_message_batch(self):
         logger.info("Send Message Batch Command started")

manage_breast_screening/notifications/management/commands/send_message_batch.py

@@ -3,14 +3,14 @@
 
 from django.core.management.base import BaseCommand
 
-from manage_breast_screening.notifications.management.commands.helpers.exception_handler import (
-    exception_handler,
+from manage_breast_screening.notifications.management.commands.helpers.command_handler import (
+    CommandHandler,
 )
 from manage_breast_screening.notifications.services.blob_storage import BlobStorage
 from manage_breast_screening.notifications.services.mesh_inbox import MeshInbox
 
 logger = getLogger(__name__)
-INSIGHTS_ERROR_NAME = "StoreMeshMessagesError"
+INSIGHTS_JOB_NAME = "StoreMeshMessages"
 
 
 class Command(BaseCommand):
@@ -20,7 +20,7 @@ class Command(BaseCommand):
     """
 
     def handle(self, *args, **options):
-        with exception_handler(INSIGHTS_ERROR_NAME):
+        with CommandHandler.handle(INSIGHTS_JOB_NAME):
             logger.info("Store MESH Messages command started")
             today_dirname = datetime.today().strftime("%Y-%m-%d")
             with MeshInbox() as inbox:
@@ -38,5 +38,3 @@ def handle(self, *args, **options):
                     inbox.acknowledge(message_id)
 
                     logger.info("Message %s acknowledged", message_id)
-
-            logger.info("Store MESH Messages command completed successfully")

manage_breast_screening/notifications/management/commands/store_mesh_messages.py

@@ -33,11 +33,20 @@ def getLogger(self):
     def exception(self, exception_name: str):
         self.logger.exception(exception_name, stack_info=True)
 
-    def custom_event(self, message: str, event_name: str):
+    def custom_event_warning(self, message: str, event_name: str):
         self.logger.warning(
             message,
             extra={
                 "microsoft.custom_event.name": event_name,
                 "additional_attrs": message,
             },
         )
+
+    def custom_event_info(self, message: str, event_name: str):
+        self.logger.info(
+            message,
+            extra={
+                "microsoft.custom_event.name": event_name,
+                "additional_attrs": message,
+            },
+        )