feat(kinesisdataanalytics): Add alarms for Checkpoints (#661)

This PR adds checkpoint alarms for Kinesis Data Analytics monitoring.

Author: costmatt-amzn

API.md

@@ -3,6 +3,12 @@ import {
   TreatMissingData,
 } from "aws-cdk-lib/aws-cloudwatch";
 
+import {
+  ErrorAlarmFactory,
+  ErrorCountThreshold,
+  ErrorRateThreshold,
+  ErrorType,
+} from "./ErrorAlarmFactory";
 import { AlarmFactory, CustomAlarmThreshold } from "../../alarm";
 import { MetricWithAlarmSupport } from "../../metric";
 
@@ -16,9 +22,11 @@ export interface FullRestartCountThreshold extends CustomAlarmThreshold {
 
 export class KinesisDataAnalyticsAlarmFactory {
   protected readonly alarmFactory: AlarmFactory;
+  protected readonly errorAlarmFactory: ErrorAlarmFactory;
 
   constructor(alarmFactory: AlarmFactory) {
     this.alarmFactory = alarmFactory;
+    this.errorAlarmFactory = new ErrorAlarmFactory(alarmFactory);
   }
 
   addDowntimeAlarm(
@@ -61,4 +69,30 @@ export class KinesisDataAnalyticsAlarmFactory {
       alarmDedupeStringSuffix: "KDAFullRestartAlarm",
     });
   }
+
+  addCheckpointFailureCountAlarm(
+    metric: MetricWithAlarmSupport,
+    props: ErrorCountThreshold,
+    disambiguator?: string,
+  ) {
+    return this.errorAlarmFactory.addErrorCountAlarm(
+      metric,
+      ErrorType.FAILURE,
+      props,
+      disambiguator,
+    );
+  }
+
+  addCheckpointFailureRateAlarm(
+    metric: MetricWithAlarmSupport,
+    props: ErrorRateThreshold,
+    disambiguator?: string,
+  ) {
+    return this.errorAlarmFactory.addErrorRateAlarm(
+      metric,
+      ErrorType.FAILURE,
+      props,
+      disambiguator,
+    );
+  }
 }

lib/common/monitoring/alarms/KinesisDataAnalyticsAlarmFactory.ts

@@ -5,6 +5,7 @@ import {
   BaseMetricFactoryProps,
   MetricFactory,
   MetricStatistic,
+  RateComputationMethod,
 } from "../../common";
 
 export interface KinesisDataAnalyticsMetricFactoryProps
@@ -118,6 +119,15 @@ export class KinesisDataAnalyticsMetricFactory extends BaseMetricFactory<Kinesis
     });
   }
 
+  metricCheckpointFailureRate() {
+    return this.metricFactory.toRate(
+      this.metricNumberOfFailedCheckpointsCount(),
+      RateComputationMethod.PER_HOUR,
+      false,
+      "checkpoints",
+    );
+  }
+
   private metric(metricsSpec: MetricsSpec) {
     return this.metricFactory.createMetric(
       metricsSpec.name,

lib/monitoring/aws-kinesisanalytics/KinesisDataAnalyticsMetricFactory.ts

@@ -13,6 +13,8 @@ import {
   CountAxisFromZero,
   DefaultGraphWidgetHeight,
   DefaultSummaryWidgetHeight,
+  ErrorCountThreshold,
+  ErrorRateThreshold,
   FullRestartCountThreshold,
   KinesisDataAnalyticsAlarmFactory,
   MaxDowntimeThreshold,
@@ -21,6 +23,7 @@ import {
   MonitoringScope,
   PercentageAxisFromZeroToHundred,
   QuarterWidth,
+  RateAxisFromZero,
   SizeAxisBytesFromZero,
   TimeAxisMillisFromZero,
 } from "../../common";
@@ -34,6 +37,10 @@ export interface KinesisDataAnalyticsMonitoringOptions
   readonly addDowntimeAlarm?: Record<string, MaxDowntimeThreshold>;
 
   readonly addFullRestartCountAlarm?: Record<string, FullRestartCountThreshold>;
+
+  readonly addCheckpointFailureCountAlarm?: Record<string, ErrorCountThreshold>;
+
+  readonly addCheckpointFailureRateAlarm?: Record<string, ErrorRateThreshold>;
 }
 
 export interface KinesisDataAnalyticsMonitoringProps
@@ -47,6 +54,8 @@ export class KinesisDataAnalyticsMonitoring extends Monitoring {
   readonly kdaAlarmFactory: KinesisDataAnalyticsAlarmFactory;
   readonly downtimeAnnotations: HorizontalAnnotation[];
   readonly fullRestartAnnotations: HorizontalAnnotation[];
+  readonly checkpointFailureCountAnnotations: HorizontalAnnotation[];
+  readonly checkpointFailureRateAnnotations: HorizontalAnnotation[];
 
   readonly cpuUtilizationPercentMetric: MetricWithAlarmSupport;
   readonly downtimeMsMetric: MetricWithAlarmSupport;
@@ -58,6 +67,7 @@ export class KinesisDataAnalyticsMonitoring extends Monitoring {
   readonly numberOfFailedCheckpointsCountMetric: MetricWithAlarmSupport;
   readonly oldGenerationGCCountMetric: MetricWithAlarmSupport;
   readonly oldGenerationGCTimeMsMetric: MetricWithAlarmSupport;
+  readonly checkpointFailureRateMetric: MetricWithAlarmSupport;
 
   constructor(
     scope: MonitoringScope,
@@ -80,6 +90,8 @@ export class KinesisDataAnalyticsMonitoring extends Monitoring {
     this.kdaAlarmFactory = new KinesisDataAnalyticsAlarmFactory(alarmFactory);
     this.downtimeAnnotations = [];
     this.fullRestartAnnotations = [];
+    this.checkpointFailureCountAnnotations = [];
+    this.checkpointFailureRateAnnotations = [];
 
     const metricFactory = new KinesisDataAnalyticsMetricFactory(
       scope.createMetricFactory(),
@@ -103,6 +115,8 @@ export class KinesisDataAnalyticsMonitoring extends Monitoring {
       metricFactory.metricOldGenerationGCCount();
     this.oldGenerationGCTimeMsMetric =
       metricFactory.metricOldGenerationGCTimeMs();
+    this.checkpointFailureRateMetric =
+      metricFactory.metricCheckpointFailureRate();
 
     for (const disambiguator in props.addDowntimeAlarm) {
       const alarmProps = props.addDowntimeAlarm[disambiguator];
@@ -126,6 +140,28 @@ export class KinesisDataAnalyticsMonitoring extends Monitoring {
       this.addAlarm(createdAlarm);
     }
 
+    for (const disambiguator in props.addCheckpointFailureCountAlarm) {
+      const alarmProps = props.addCheckpointFailureCountAlarm[disambiguator];
+      const createdAlarm = this.kdaAlarmFactory.addCheckpointFailureCountAlarm(
+        this.numberOfFailedCheckpointsCountMetric,
+        alarmProps,
+        disambiguator,
+      );
+      this.checkpointFailureCountAnnotations.push(createdAlarm.annotation);
+      this.addAlarm(createdAlarm);
+    }
+
+    for (const disambiguator in props.addCheckpointFailureRateAlarm) {
+      const alarmProps = props.addCheckpointFailureRateAlarm[disambiguator];
+      const createdAlarm = this.kdaAlarmFactory.addCheckpointFailureRateAlarm(
+        this.checkpointFailureRateMetric,
+        alarmProps,
+        disambiguator,
+      );
+      this.checkpointFailureRateAnnotations.push(createdAlarm.annotation);
+      this.addAlarm(createdAlarm);
+    }
+
     props.useCreatedAlarms?.consume(this.createdAlarms());
   }
 
@@ -204,6 +240,10 @@ export class KinesisDataAnalyticsMonitoring extends Monitoring {
       title: "Checkpoint Failures",
       left: [this.numberOfFailedCheckpointsCountMetric],
       leftYAxis: CountAxisFromZero,
+      leftAnnotations: this.checkpointFailureCountAnnotations,
+      right: [this.checkpointFailureRateMetric],
+      rightYAxis: RateAxisFromZero,
+      rightAnnotations: this.checkpointFailureRateAnnotations,
     });
   }