feat(KinesisFirehoseMonitoring): add isDataFormatConversionEnabled prop (#627)

The conversions widget is useless for any Firehose which doesn't have
data format conversions enabled.

Default is true for backwards compatability.

Implementation is based on the similar `isIterator` parameter for Lambda
Functions.

Note that the AWS docs are not consistent about what they call this
feature, [sometimes calling it data format conversion, sometimes calling
it record format
conversion](https://docs.aws.amazon.com/firehose/latest/dev/enable-record-format-conversion.html).
CDK calls it [data format
conversion](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.DataFormatConversionConfigurationProperty.html),
hence my choice to use that terminology for the parameter too.

The library doesn't currently support enabling alarms on any of the data
format conversion metrics, so we don't need additional checks there.

I've not written any new tests validating if this widget is shown based
on the param, since the similar `isIterator` parameter also has no tests
for this; happy to add some if you wish, but if so I'd appreciate a
pointer to a similar existing test to help me understand this repo's
testing approach.

---

_By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license_

Co-authored-by: Paul Sinclair <pssincl@amazon.com>

Author: pbsinclair42

API.md

@@ -23,13 +23,23 @@ import {
   RecordsThrottledThreshold,
   FirehoseStreamLimitThreshold,
   TimeAxisMillisFromZero,
+  FullWidth,
+  ThirdWidth,
 } from "../../common";
 import {
   MonitoringHeaderWidget,
   MonitoringNamingStrategy,
 } from "../../dashboard";
 
 export interface KinesisFirehoseMonitoringOptions extends BaseMonitoringProps {
+  /**
+   * Indicates that the Kinesis Firehose has record format conversion enabled.
+   * This impacts what widgets are shown.
+   *
+   * @default - true
+   * @see https://docs.aws.amazon.com/firehose/latest/dev/enable-record-format-conversion.html
+   */
+  readonly isDataFormatConversionEnabled?: boolean;
   readonly addRecordsThrottledAlarm?: Record<string, RecordsThrottledThreshold>;
   readonly addIncomingBytesExceedThresholdAlarm?: Record<
     string,
@@ -60,8 +70,11 @@ export class KinesisFirehoseMonitoring extends Monitoring {
   readonly incomingBytesMetric: MetricWithAlarmSupport;
   readonly incomingRecordsMetric: MetricWithAlarmSupport;
   readonly throttledRecordsMetric: MetricWithAlarmSupport;
+
+  readonly isDataFormatConversionEnabled: boolean;
   readonly successfulConversionMetric: MetricWithAlarmSupport;
   readonly failedConversionMetric: MetricWithAlarmSupport;
+
   readonly putRecordLatency: MetricWithAlarmSupport;
   readonly putRecordBatchLatency: MetricWithAlarmSupport;
   readonly incomingBytesToLimitRate: MetricWithAlarmSupport;
@@ -94,6 +107,9 @@ export class KinesisFirehoseMonitoring extends Monitoring {
     this.incomingBytesMetric = metricFactory.metricIncomingBytes();
     this.incomingRecordsMetric = metricFactory.metricIncomingRecordCount();
     this.throttledRecordsMetric = metricFactory.metricThrottledRecordCount();
+
+    this.isDataFormatConversionEnabled =
+      props.isDataFormatConversionEnabled ?? true;
     this.successfulConversionMetric =
       metricFactory.metricSuccessfulConversionCount();
     this.failedConversionMetric = metricFactory.metricFailedConversionCount();
@@ -167,21 +183,37 @@ export class KinesisFirehoseMonitoring extends Monitoring {
   }
 
   summaryWidgets(): IWidget[] {
-    return [
+    const widgetWidth = this.isDataFormatConversionEnabled
+      ? HalfWidth
+      : FullWidth;
+    const widgets = [
       this.createTitleWidget(),
-      this.createIncomingRecordWidget(HalfWidth, DefaultSummaryWidgetHeight),
-      this.createConversionWidget(HalfWidth, DefaultSummaryWidgetHeight),
+      this.createIncomingRecordWidget(widgetWidth, DefaultSummaryWidgetHeight),
     ];
+    if (this.isDataFormatConversionEnabled) {
+      widgets.push(
+        this.createConversionWidget(widgetWidth, DefaultSummaryWidgetHeight),
+      );
+    }
+    return widgets;
   }
 
   widgets(): IWidget[] {
-    return [
+    const widgetWidth = this.isDataFormatConversionEnabled
+      ? QuarterWidth
+      : ThirdWidth;
+    let widgets = [
       this.createTitleWidget(),
-      this.createIncomingRecordWidget(QuarterWidth, DefaultGraphWidgetHeight),
-      this.createLatencyWidget(QuarterWidth, DefaultGraphWidgetHeight),
-      this.createConversionWidget(QuarterWidth, DefaultGraphWidgetHeight),
-      this.createLimitWidget(QuarterWidth, DefaultGraphWidgetHeight),
+      this.createIncomingRecordWidget(widgetWidth, DefaultGraphWidgetHeight),
+      this.createLatencyWidget(widgetWidth, DefaultGraphWidgetHeight),
     ];
+    if (this.isDataFormatConversionEnabled) {
+      widgets.push(
+        this.createConversionWidget(widgetWidth, DefaultGraphWidgetHeight),
+      );
+    }
+    widgets.push(this.createLimitWidget(widgetWidth, DefaultGraphWidgetHeight));
+    return widgets;
   }
 
   createTitleWidget() {

lib/monitoring/aws-kinesis/KinesisFirehoseMonitoring.ts

@@ -59,6 +59,20 @@ test("snapshot test: all alarms", () => {
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
 
+test("snapshot test: data format conversion disabled", () => {
+  const stack = new Stack();
+
+  const scope = new TestMonitoringScope(stack, "Scope");
+
+  const monitoring = new KinesisFirehoseMonitoring(scope, {
+    deliveryStreamName: "my-firehose-delivery-stream",
+    isDataFormatConversionEnabled: false,
+  });
+
+  addMonitoringDashboardsToStack(stack, monitoring);
+  expect(Template.fromStack(stack)).toMatchSnapshot();
+});
+
 test("test: validation error if incoming traffic usage alarm threshold equal to 1", () => {
   const stack = new Stack();