CCM-17116: Adding dimensions

nhsd-angel-pastor · nhsd-angel-pastor · commit 009396ecedc8 · 2026-04-29T14:57:46.000+01:00
diff --git a/lambdas/core-notifier-lambda/src/container.ts b/lambdas/core-notifier-lambda/src/container.ts
@@ -1,5 +1,8 @@
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   ParameterStoreCache,
   createGetApimAccessToken,
@@ -48,11 +51,11 @@ export async function createContainer(): Promise<SqsHandlerDependencies> {
     eventPublisherEventBusArn,
   } = config;
   const metricHandler = new MetricHandler(dlMetricsNamespace, [
-    {
-      Name: 'Environment',
-      Value: config.environment,
-    },
-  ]);
+      { Name: DimensionName.Environment, Value: config.environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.DigitalLetter },
+      { Name: DimensionName.Component, Value: ComponentDimension.CoreNotify },
+      { Name: DimensionName.LambdaFunction, Value: 'core-notifier' },
+    ]);
 
   const eventPublisher = new EventPublisher({
     eventBusArn: eventPublisherEventBusArn,
diff --git a/lambdas/file-scanner-lambda/src/container.ts b/lambdas/file-scanner-lambda/src/container.ts
@@ -2,7 +2,10 @@ import { HandlerDependencies } from 'apis/sqs-handler';
 import { FileScanner } from 'app/file-scanner';
 import { loadConfig } from 'infra/config';
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   eventBridgeClient,
   logger,
@@ -28,7 +31,10 @@ export const createContainer = (): HandlerDependencies => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.Print },
+      { Name: DimensionName.Component, Value: ComponentDimension.VirusScanning },
+      { Name: DimensionName.LambdaFunction, Value: 'file-scanner' },
     ]),
   });
 
diff --git a/lambdas/move-scanned-files-lambda/src/container.ts b/lambdas/move-scanned-files-lambda/src/container.ts
@@ -1,5 +1,8 @@
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   eventBridgeClient,
   logger,
@@ -25,7 +28,10 @@ export async function createContainer(): Promise<SqsHandlerDependencies> {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: config.environment },
+      { Name: DimensionName.Environment, Value: config.environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.DigitalLetter },
+      { Name: DimensionName.Component, Value: ComponentDimension.VirusScanning },
+      { Name: DimensionName.LambdaFunction, Value: 'move-scanned-files' },
     ]),
   });
 
diff --git a/lambdas/nhsapp-status-handler/src/container.ts b/lambdas/nhsapp-status-handler/src/container.ts
@@ -1,4 +1,10 @@
 import {
+  ComponentDimension,
+  ComponentDimension,
+  DimensionName,
+  DimensionName,
+  FlowDimension,
+  FlowDimension,
   EventPublisher,
   MetricHandler,
   dynamoDocumentClient,
@@ -33,7 +39,10 @@ export const createContainer = () => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.DigitalLetter },
+      { Name: DimensionName.Component, Value: ComponentDimension.Callbacks },
+      { Name: DimensionName.LambdaFunction, Value: 'nhsapp-status-handler' },
     ]),
   });
 
diff --git a/lambdas/pdm-poll-lambda/src/container.ts b/lambdas/pdm-poll-lambda/src/container.ts
@@ -10,6 +10,9 @@ import {
   eventBridgeClient,
   logger,
   sqsClient,
+  DimensionName,
+  FlowDimension,
+  ComponentDimension,
 } from 'utils';
 
 export const createContainer = (): HandlerDependencies => {
@@ -30,7 +33,10 @@ export const createContainer = (): HandlerDependencies => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.DigitalLetter },
+      { Name: DimensionName.Component, Value: ComponentDimension.PDM },
+      { Name: DimensionName.LambdaFunction, Value: 'pdm-poll' },
     ]),
   });
 
diff --git a/lambdas/pdm-uploader-lambda/src/__tests__/container.test.ts b/lambdas/pdm-uploader-lambda/src/__tests__/container.test.ts
@@ -24,6 +24,28 @@ jest.mock('utils', () => ({
   ParameterStoreCache: jest.fn(() => ({})),
   PdmClient: jest.fn(() => ({})),
   sqsClient: {},
+  DimensionName: {
+    Component: 'Component',
+    Flow: 'Flow',
+    Environment: 'Environment',
+    SenderId: 'SenderId',
+    LambdaFunction: 'LambdaFunction',
+  },
+  FlowDimension: {
+    DigitalLetter: 'Digital Letter',
+    Print: 'Print',
+    TrustReporting: 'Trust Reporting',
+  },
+  ComponentDimension: {
+    MESH: 'MESH',
+    PDM: 'PDM',
+    TTL: 'TTL',
+    CoreNotify: 'Core Notify',
+    VirusScanning: 'Virus Scanning',
+    PrintRequest: 'Print Request',
+    Reporting: 'Reporting',
+    Callbacks: 'Callbacks',
+  },
 }));
 
 describe('container', () => {
diff --git a/lambdas/pdm-uploader-lambda/src/container.ts b/lambdas/pdm-uploader-lambda/src/container.ts
@@ -1,5 +1,8 @@
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   ParameterStoreCache,
   PdmClient,
@@ -42,7 +45,10 @@ export const createContainer = () => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.DigitalLetter },
+      { Name: DimensionName.Component, Value: ComponentDimension.PDM },
+      { Name: DimensionName.LambdaFunction, Value: 'pdm-uploader' },
     ]),
   });
 
diff --git a/lambdas/print-analyser/src/container.ts b/lambdas/print-analyser/src/container.ts
@@ -1,7 +1,10 @@
 import { HandlerDependencies } from 'apis/sqs-handler';
 import { loadConfig } from 'infra/config';
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   eventBridgeClient,
   logger,
@@ -23,7 +26,10 @@ export const createContainer = (): HandlerDependencies => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.Print },
+      { Name: DimensionName.Component, Value: ComponentDimension.PrintRequest },
+      { Name: DimensionName.LambdaFunction, Value: 'print-analyser' },
     ]),
   });
 
diff --git a/lambdas/print-sender-lambda/src/container.ts b/lambdas/print-sender-lambda/src/container.ts
@@ -1,5 +1,8 @@
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   eventBridgeClient,
   logger,
@@ -18,8 +21,11 @@ export const createContainer = () => {
   } = loadConfig();
 
   const metricHandler = new MetricHandler(dlMetricsNamespace, [
-    { Name: 'Environment', Value: environment },
-  ]);
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.Print },
+      { Name: DimensionName.Component, Value: ComponentDimension.PrintRequest },
+      { Name: DimensionName.LambdaFunction, Value: 'print-sender' },
+    ]);
 
   const eventPublisher = new EventPublisher({
     eventBusArn: eventPublisherEventBusArn,
diff --git a/lambdas/print-status-handler/src/container.ts b/lambdas/print-status-handler/src/container.ts
@@ -1,7 +1,10 @@
 import { HandlerDependencies } from 'apis/sqs-handler';
 import { loadConfig } from 'infra/config';
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   eventBridgeClient,
   logger,
@@ -23,7 +26,10 @@ export const createContainer = (): HandlerDependencies => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.Print },
+      { Name: DimensionName.Component, Value: ComponentDimension.Callbacks },
+      { Name: DimensionName.LambdaFunction, Value: 'print-status-handler' },
     ]),
   });
 
diff --git a/lambdas/report-generator/src/container.ts b/lambdas/report-generator/src/container.ts
@@ -1,7 +1,10 @@
 import {
   AthenaDataRepository,
   AthenaDataRepositoryDependencies,
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   ReportService,
   S3StorageRepository,
@@ -60,8 +63,11 @@ export const createContainer = () => {
   );
 
   const metricHandler = new MetricHandler(dlMetricsNamespace, [
-    { Name: 'Environment', Value: environment },
-  ]);
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.TrustReporting },
+      { Name: DimensionName.Component, Value: ComponentDimension.Reporting },
+      { Name: DimensionName.LambdaFunction, Value: 'report-generator' },
+    ]);
 
   const eventPublisher = new EventPublisher({
     eventBusArn: eventPublisherEventBusArn,
diff --git a/lambdas/report-scheduler/src/container.ts b/lambdas/report-scheduler/src/container.ts
@@ -2,7 +2,10 @@ import { loadConfig } from 'infra/config';
 import { CreateHandlerDependencies } from 'apis/scheduled-event-handler';
 import { SenderManagement } from 'sender-management';
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   ParameterStoreCache,
   eventBridgeClient,
@@ -24,8 +27,11 @@ export const createContainer = (): CreateHandlerDependencies => {
   });
 
   const metricHandler = new MetricHandler(dlMetricsNamespace, [
-    { Name: 'Environment', Value: environment },
-  ]);
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.TrustReporting },
+      { Name: DimensionName.Component, Value: ComponentDimension.Reporting },
+      { Name: DimensionName.LambdaFunction, Value: 'report-scheduler' },
+    ]);
 
   const eventPublisher = new EventPublisher({
     eventBusArn: eventPublisherEventBusArn,
diff --git a/lambdas/ttl-create-lambda/src/container.ts b/lambdas/ttl-create-lambda/src/container.ts
@@ -1,5 +1,8 @@
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   ParameterStoreCache,
   dynamoClient,
@@ -46,7 +49,10 @@ export const createContainer = () => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.DigitalLetter },
+      { Name: DimensionName.Component, Value: ComponentDimension.TTL },
+      { Name: DimensionName.LambdaFunction, Value: 'ttl-create' },
     ]),
   });
 
diff --git a/lambdas/ttl-handle-expiry-lambda/src/container.ts b/lambdas/ttl-handle-expiry-lambda/src/container.ts
@@ -1,5 +1,8 @@
 import {
+  ComponentDimension,
+  DimensionName,
   EventPublisher,
+  FlowDimension,
   MetricHandler,
   eventBridgeClient,
   logger,
@@ -25,7 +28,10 @@ export const createContainer = (): CreateHandlerDependencies => {
     sqsClient,
     eventBridgeClient,
     metricHandler: new MetricHandler(dlMetricsNamespace, [
-      { Name: 'Environment', Value: environment },
+      { Name: DimensionName.Environment, Value: environment },
+      { Name: DimensionName.Flow, Value: FlowDimension.Print },
+      { Name: DimensionName.Component, Value: ComponentDimension.TTL },
+      { Name: DimensionName.LambdaFunction, Value: 'ttl-handle-expiry' },
     ]),
   });
 
diff --git a/utils/utils/src/cloudwatch/metric-handler.ts b/utils/utils/src/cloudwatch/metric-handler.ts
@@ -31,6 +31,37 @@ export type MetricUnit =
   | 'Count/Second'
   | 'None';
 
+export const DimensionName = {
+  Component: 'Component',
+  Flow: 'Flow',
+  Environment: 'Environment',
+  SenderId: 'SenderId',
+  LambdaFunction: 'LambdaFunction',
+} as const;
+
+export type DimensionName = typeof DimensionName[keyof typeof DimensionName];
+
+export const ComponentDimension = {
+  MESH: 'MESH',
+  PDM: 'PDM',
+  TTL: 'TTL',
+  CoreNotify: 'Core Notify',
+  VirusScanning: 'Virus Scanning',
+  PrintRequest: 'Print Request',
+  Reporting: 'Reporting',
+  Callbacks: 'Callbacks',
+} as const;
+
+export type ComponentDimension = typeof ComponentDimension[keyof typeof ComponentDimension];
+
+export const FlowDimension = {
+  DigitalLetter: 'Digital Letter',
+  Print: 'Print',
+  TrustReporting: 'Trust Reporting',
+} as const;
+
+export type FlowDimension = typeof FlowDimension[keyof typeof FlowDimension];
+
 type Metric = [name: string, unit: MetricUnit, value: number];
 
 export class MetricHandler {
