Expose key metrics to cloudwatch

README.md

@@ -138,3 +138,5 @@ Deployments can be made of any [release](https://github.com/NHSDigital/nhs-notif
 Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
 
 Any HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
+
+to open a PR

infrastructure/terraform/components/api/module_lambda_upsert_letter.tf

@@ -85,4 +85,16 @@ data "aws_iam_policy_document" "upsert_letter_lambda" {
       module.sqs_letter_updates.sqs_queue_arn
     ]
   }
+
+  statement {
+    sid = "AllowCloudWatchMetrics"
+    effect = "Allow"
+
+    actions = [
+      "cloudwatch:PutMetricData"
+    ]
+
+    resources = ["*"]
+  }
+
 }

lambdas/upsert-letter/package.json

@@ -1,12 +1,14 @@
 {
   "dependencies": {
+    "@aws-sdk/client-cloudwatch": "^3.972.0",
     "@aws-sdk/client-dynamodb": "^3.858.0",
     "@aws-sdk/lib-dynamodb": "^3.858.0",
     "@internal/datastore": "*",
     "@nhsdigital/nhs-notify-event-schemas-letter-rendering": "^2.0.1",
     "@nhsdigital/nhs-notify-event-schemas-letter-rendering-v1": "npm:@nhsdigital/nhs-notify-event-schemas-letter-rendering@^1.1.5",
     "@nhsdigital/nhs-notify-event-schemas-supplier-api": "^1.0.8",
     "@types/aws-lambda": "^8.10.148",
+    "aws-embedded-metrics": "^4.2.1",
     "aws-lambda": "^1.0.7",
     "esbuild": "^0.27.2",
     "pino": "^9.7.0",

lambdas/upsert-letter/src/handler/upsert-handler.ts

@@ -19,6 +19,7 @@
   LetterRequestPreparedEventV2,
 } from "@nhsdigital/nhs-notify-event-schemas-letter-rendering";
 import z from "zod";
+import { Unit, metricScope } from "aws-embedded-metrics";
 import { Deps } from "../config/deps";
 
 type SupplierSpec = { supplierId: string; specId: string };
@@ -153,33 +154,57 @@
 }
 
 export default function createUpsertLetterHandler(deps: Deps): SQSHandler {
-  return async (event: SQSEvent) => {
-    const batchItemFailures: SQSBatchItemFailure[] = [];
-
-    const tasks = event.Records.map(async (record) => {
-      try {
-        const message: string = parseSNSNotification(record);
-
-        const snsEvent = JSON.parse(message);
-
-        const letterEvent: unknown = removeEventBridgeWrapper(snsEvent);
-
-        const type = getType(letterEvent);
-
-        const operation = getOperationFromType(type);
-
-        await runUpsert(operation, letterEvent, deps);
-      } catch (error) {
-        deps.logger.error(
-          { err: error, message: record.body },
-          `Error processing upsert of record ${record.messageId}`,
-        );
-        batchItemFailures.push({ itemIdentifier: record.messageId });
-      }
-    });
-
-    await Promise.all(tasks);
-
-    return { batchItemFailures };
-  };
+  return metricScope((metrics) => {
+    return async (event: SQSEvent) => {
+      console.log(
+        "the environment variables:",
+        JSON.stringify(process.env, null, 2),
+      );
+      console.log("The SQSEvent:", event);
+      const batchItemFailures: SQSBatchItemFailure[] = [];
+      metrics.setNamespace("vlasis_upsertLetter");
+
+      const tasks = event.Records.map(async (record) => {
+        try {
+          const message: string = parseSNSNotification(record);
+          console.log("the message:", message);
+
+          const snsEvent = JSON.parse(message);
+          console.log("the snsEvent:", snsEvent);
+
+          const letterEvent: unknown = removeEventBridgeWrapper(snsEvent);
+
+          const type = getType(letterEvent);
+
+          const operation = getOperationFromType(type);
+          metrics.putDimensions({
+            FunctionName: "upsertLambda",
+            // eslint-disable-next-line sonarjs/pseudo-random
+            OddOrEven: `${Math.floor(Math.random() * 10) % 2}`,
+          });
+
+          await runUpsert(operation, letterEvent, deps);
+          metrics.setProperty("operation", operation.name);
+
+          metrics.putMetric("MessagesProcessed", 1, Unit.Count);
+        } catch (error) {
+          deps.logger.error(
+            { err: error, message: record.body },
+            `Error processing upsert of record ${record.messageId}`,
+          );
+          metrics.putDimensions({
+            FunctionName: "upsertLambda",
+            // eslint-disable-next-line sonarjs/pseudo-random
+            OddOrEven: `${Math.floor(Math.random() * 10) % 2}`,
+          });
+          metrics.putMetric("MessageFailed", 1, Unit.Count);
+          batchItemFailures.push({ itemIdentifier: record.messageId });
+        }
+      });
+
+      await Promise.all(tasks);
+
+      return { batchItemFailures };
+    };
+  });
 }