feat(logs): add addMaxIncomingLogsAlarm (#504)

Closes #495 --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_
cdklabs · Mar 22, 2024 · b9176a5 · b9176a5
1 parent 040845d
commit b9176a5
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 3 deletions.
diff --git a/API.md b/API.md
diff --git a/lib/monitoring/aws-cloudwatch/LogMonitoring.ts b/lib/monitoring/aws-cloudwatch/LogMonitoring.ts
@@ -17,6 +17,7 @@ import {
   DefaultLogWidgetHeight,
   DefaultSummaryWidgetHeight,
   FullWidth,
+  MaxUsageCountThreshold,
   MetricWithAlarmSupport,
   MinUsageCountThreshold,
   Monitoring,
@@ -55,6 +56,7 @@ export interface LogMonitoringProps
   readonly limit?: number;
 
   readonly addMinIncomingLogsAlarm?: Record<string, MinUsageCountThreshold>;
+  readonly addMaxIncomingLogsAlarm?: Record<string, MaxUsageCountThreshold>;
 }
 
 /**
@@ -116,6 +118,17 @@ export class LogMonitoring extends Monitoring {
       this.addAlarm(createdAlarm);
     }
 
+    for (const disambiguator in props.addMaxIncomingLogsAlarm) {
+      const alarmProps = props.addMaxIncomingLogsAlarm[disambiguator];
+      const createdAlarm = this.usageAlarmFactory.addMaxCountAlarm(
+        this.incomingLogEventsMetric,
+        alarmProps,
+        disambiguator
+      );
+      this.usageAnnotations.push(createdAlarm.annotation);
+      this.addAlarm(createdAlarm);
+    }
+
     props.useCreatedAlarms?.consume(this.createdAlarms());
   }
 

diff --git a/test/monitoring/aws-cloudwatch/LogMonitoring.test.ts b/test/monitoring/aws-cloudwatch/LogMonitoring.test.ts
@@ -65,6 +65,11 @@ test("snapshot test: with alarms", () => {
         treatMissingDataOverride: TreatMissingData.BREACHING,
       },
     },
+    addMaxIncomingLogsAlarm: {
+      Critical: {
+        maxCount: 9001,
+      },
+    },
     useCreatedAlarms: {
       consume(alarms) {
         numAlarmsCreated = alarms.length;
@@ -73,6 +78,6 @@ test("snapshot test: with alarms", () => {
   });
 
   addMonitoringDashboardsToStack(stack, monitoring);
-  expect(numAlarmsCreated).toStrictEqual(1);
+  expect(numAlarmsCreated).toStrictEqual(2);
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
diff --git a/test/monitoring/aws-cloudwatch/__snapshots__/LogMonitoring.test.ts.snap b/test/monitoring/aws-cloudwatch/__snapshots__/LogMonitoring.test.ts.snap