feat: extend metric factories with custom rate computation method (#121)

Related to #50 

---

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

Author: voho

API.md

@@ -61,8 +61,10 @@ export class ApiGatewayMetricFactory {
     };
   }
 
+  /**
+   * @deprecated use metricInvocationRate
+   */
   metricTps() {
-    // TODO: rename to metricInvocationRate and use rateComputationMethod
     return this.metricFactory.toRate(
       this.metricInvocationCount(),
       RateComputationMethod.PER_SECOND,
@@ -72,6 +74,16 @@ export class ApiGatewayMetricFactory {
     );
   }
 
+  metricInvocationRate() {
+    return this.metricFactory.toRate(
+      this.metricInvocationCount(),
+      this.rateComputationMethod,
+      false,
+      "requests",
+      this.fillTpsWithZeroes
+    );
+  }
+
   metricInvocationCount() {
     return this.metricFactory.createMetric(
       "Count",

lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.ts

@@ -58,8 +58,10 @@ export class ApiGatewayV2HttpApiMetricFactory {
     };
   }
 
+  /**
+   * @deprecated use metricInvocationRate
+   */
   metricTps() {
-    // TODO: rename to metricInvocationRate and use rateComputationMethod
     return this.metricFactory.toRate(
       this.metricInvocationCount(),
       RateComputationMethod.PER_SECOND,
@@ -68,6 +70,15 @@ export class ApiGatewayV2HttpApiMetricFactory {
     );
   }
 
+  metricInvocationRate() {
+    return this.metricFactory.toRate(
+      this.metricInvocationCount(),
+      this.rateComputationMethod,
+      false,
+      "requests"
+    );
+  }
+
   metricInvocationCount() {
     return this.metricFactory.createMetric(
       "Count",

lib/monitoring/aws-apigatewayv2/ApiGatewayV2HttpApiMetricFactory.ts

@@ -42,8 +42,10 @@ export class AppSyncMetricFactory {
     };
   }
 
+  /**
+   * @deprecated use metricRequestRate
+   */
   metricTps() {
-    // TODO: rename to metricInvocationRate and use rateComputationMethod
     return this.metricFactory.toRate(
       this.metricRequestCount(),
       RateComputationMethod.PER_SECOND,
@@ -53,6 +55,16 @@ export class AppSyncMetricFactory {
     );
   }
 
+  metricRequestRate() {
+    return this.metricFactory.toRate(
+      this.metricRequestCount(),
+      this.rateComputationMethod,
+      true,
+      "requests",
+      this.fillTpsWithZeroes
+    );
+  }
+
   metricRequestCount() {
     return this.metricFactory.createMetric(
       "Latency",

lib/monitoring/aws-appsync/AppSyncMetricFactory.ts

@@ -17,6 +17,10 @@ export interface CloudFrontDistributionMetricFactoryProps {
    * @default true
    */
   readonly fillTpsWithZeroes?: boolean;
+  /**
+   * @default average
+   */
+  readonly rateComputationMethod?: RateComputationMethod;
 }
 
 /**
@@ -26,6 +30,7 @@ export interface CloudFrontDistributionMetricFactoryProps {
 export class CloudFrontDistributionMetricFactory {
   private readonly metricFactory: MetricFactory;
   private readonly fillTpsWithZeroes: boolean;
+  private readonly rateComputationMethod: RateComputationMethod;
   private readonly dimensionsMap: DimensionsMap;
 
   constructor(
@@ -34,6 +39,8 @@ export class CloudFrontDistributionMetricFactory {
   ) {
     this.metricFactory = metricFactory;
     this.fillTpsWithZeroes = props.fillTpsWithZeroes ?? true;
+    this.rateComputationMethod =
+      props.rateComputationMethod ?? RateComputationMethod.AVERAGE;
     this.dimensionsMap = {
       DistributionId: props.distribution.distributionId,
       Region: CloudFrontGlobalRegion,
@@ -53,8 +60,20 @@ export class CloudFrontDistributionMetricFactory {
       .with({ region: CloudFrontDefaultMetricRegion });
   }
 
+  metricRequestRate() {
+    return this.metricFactory.toRate(
+      this.metricRequestCount(),
+      this.rateComputationMethod,
+      false,
+      "requests",
+      this.fillTpsWithZeroes
+    );
+  }
+
+  /**
+   * @deprecated use metricRequestRate
+   */
   metricRequestTps() {
-    // TODO: rename to metricInvocationRate and use rateComputationMethod
     return this.metricFactory.toRate(
       this.metricRequestCount(),
       RateComputationMethod.PER_SECOND,

lib/monitoring/aws-cloudfront/CloudFrontDistributionMetricFactory.ts

@@ -8,16 +8,27 @@ import {
 
 const GlueNamespace = "Glue";
 
+export interface GlueJobMetricFactoryProps {
+  readonly jobName: string;
+  /**
+   * @default average
+   */
+  readonly rateComputationMethod?: RateComputationMethod;
+}
+
 export class GlueJobMetricFactory {
   protected readonly metricFactory: MetricFactory;
+  protected readonly rateComputationMethod: RateComputationMethod;
   protected readonly dimensionsMap: DimensionsMap;
 
-  constructor(metricFactory: MetricFactory, jobName: string) {
+  constructor(metricFactory: MetricFactory, props: GlueJobMetricFactoryProps) {
     this.metricFactory = metricFactory;
+    this.rateComputationMethod =
+      props.rateComputationMethod ?? RateComputationMethod.AVERAGE;
     this.dimensionsMap = {
       Type: "gauge",
       JobRunId: "ALL",
-      JobName: jobName,
+      JobName: props.jobName,
     };
   }
 
@@ -112,7 +123,7 @@ export class GlueJobMetricFactory {
   metricFailedTasksRate() {
     return this.metricFactory.toRate(
       this.metricFailedTasksSum(),
-      RateComputationMethod.AVERAGE,
+      this.rateComputationMethod,
       true,
       "killed",
       false
@@ -133,7 +144,7 @@ export class GlueJobMetricFactory {
   metricKilledTasksRate() {
     return this.metricFactory.toRate(
       this.metricKilledTasksSum(),
-      RateComputationMethod.AVERAGE,
+      this.rateComputationMethod,
       true,
       "killed",
       false

lib/monitoring/aws-glue/GlueJobMetricFactory.ts

@@ -28,18 +28,21 @@ import {
   MonitoringHeaderWidget,
   MonitoringNamingStrategy,
 } from "../../dashboard";
-import { GlueJobMetricFactory } from "./GlueJobMetricFactory";
+import {
+  GlueJobMetricFactory,
+  GlueJobMetricFactoryProps,
+} from "./GlueJobMetricFactory";
 
-export interface GlueJobMonitoringOptions extends BaseMonitoringProps {
+export interface GlueJobMonitoringOptions
+  extends GlueJobMetricFactoryProps,
+    BaseMonitoringProps {
   readonly addFailedTaskCountAlarm?: Record<string, ErrorCountThreshold>;
   readonly addFailedTaskRateAlarm?: Record<string, ErrorRateThreshold>;
   readonly addKilledTaskCountAlarm?: Record<string, ErrorCountThreshold>;
   readonly addKilledTaskRateAlarm?: Record<string, ErrorRateThreshold>;
 }
 
-export interface GlueJobMonitoringProps extends GlueJobMonitoringOptions {
-  readonly jobName: string;
-}
+export interface GlueJobMonitoringProps extends GlueJobMonitoringOptions {}
 
 export class GlueJobMonitoring extends Monitoring {
   protected readonly title: string;
@@ -74,7 +77,7 @@ export class GlueJobMonitoring extends Monitoring {
 
     const metricFactory = new GlueJobMetricFactory(
       scope.createMetricFactory(),
-      props.jobName
+      props
     );
 
     this.alarmFactory = this.createAlarmFactory(

lib/monitoring/aws-glue/GlueJobMonitoring.ts

@@ -44,8 +44,10 @@ export class LambdaFunctionMetricFactory {
       props.rateComputationMethod ?? RateComputationMethod.AVERAGE;
   }
 
+  /**
+   * @deprecated use metricInvocationRate
+   */
   metricTps() {
-    // TODO: rename to metricInvocationRate and use rateComputationMethod
     return this.metricFactory.toRate(
       this.metricInvocationCount(),
       RateComputationMethod.PER_SECOND,
@@ -55,6 +57,16 @@ export class LambdaFunctionMetricFactory {
     );
   }
 
+  metricInvocationRate() {
+    return this.metricFactory.toRate(
+      this.metricInvocationCount(),
+      this.rateComputationMethod,
+      false,
+      "requests",
+      this.fillTpsWithZeroes
+    );
+  }
+
   metricInvocationCount() {
     return this.metricFactory.adaptMetric(
       this.lambdaFunction.metricInvocations({

lib/monitoring/aws-lambda/LambdaFunctionMetricFactory.ts

@@ -16,12 +16,17 @@ export interface OpenSearchClusterMetricFactoryProps {
    * @default true
    */
   readonly fillTpsWithZeroes?: boolean;
+  /**
+   * @default average
+   */
+  readonly rateComputationMethod?: RateComputationMethod;
 }
 
 export class OpenSearchClusterMetricFactory {
   protected readonly metricFactory: MetricFactory;
   protected readonly domainMetrics: OpenSearchBackportedMetrics;
   protected readonly fillTpsWithZeroes: boolean;
+  protected readonly rateComputationMethod: RateComputationMethod;
 
   constructor(
     metricFactory: MetricFactory,
@@ -30,15 +35,32 @@ export class OpenSearchClusterMetricFactory {
     this.metricFactory = metricFactory;
     this.domainMetrics = new OpenSearchBackportedMetrics(props.domain);
     this.fillTpsWithZeroes = props.fillTpsWithZeroes ?? true;
+    this.rateComputationMethod =
+      props.rateComputationMethod ?? RateComputationMethod.AVERAGE;
   }
 
-  metricTps() {
-    // TODO: rename to metricInvocationRate and use rateComputationMethod
-    const requests = this.domainMetrics.metric("SearchRate", {
+  metricSearchCount() {
+    return this.domainMetrics.metric("SearchRate", {
       statistic: Statistic.SUM,
     });
+  }
+
+  metricSearchRate() {
+    return this.metricFactory.toRate(
+      this.metricSearchCount(),
+      this.rateComputationMethod,
+      false,
+      "requests",
+      this.fillTpsWithZeroes
+    );
+  }
+
+  /**
+   * @deprecated use metricSearchRate
+   */
+  metricTps() {
     return this.metricFactory.toRate(
-      requests,
+      this.metricSearchCount(),
       RateComputationMethod.PER_SECOND,
       false,
       "requests",