cdk-monitoring-constructs/lib/monitoring/aws-apigateway/ApiGatewayMetricFactory.js

[](https://gitpod.io/#https://github.com/cdklabs/cdk-monitoring-constructs) [](https://badge

"use strict";
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ApiGatewayMetricFactory = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const common_1 = require("../../common");
const ApiGatewayNamespace = "AWS/ApiGateway";
class ApiGatewayMetricFactory {
    constructor(metricFactory, props) {
        this.metricFactory = metricFactory;
        this.fillTpsWithZeroes = props.fillTpsWithZeroes ?? true;
        this.rateComputationMethod =
            props.rateComputationMethod ?? common_1.RateComputationMethod.AVERAGE;
        this.dimensionsMap = {
            ApiName: props.api.restApiName,
            Stage: props.apiStage ?? "prod",
            ...(props.apiMethod && { Method: props.apiMethod }),
            ...(props.apiResource && { Resource: props.apiResource }),
        };
    }
    /**
     * @deprecated use metricInvocationRate
     */
    metricTps() {
        return this.metricFactory.toRate(this.metricInvocationCount(), common_1.RateComputationMethod.PER_SECOND, false, "requests", this.fillTpsWithZeroes);
    }
    metricInvocationRate() {
        return this.metricFactory.toRate(this.metricInvocationCount(), this.rateComputationMethod, false, "requests", this.fillTpsWithZeroes);
    }
    metricInvocationCount() {
        return this.metricFactory.createMetric("Count", common_1.MetricStatistic.SUM, "Count", this.dimensionsMap, undefined, ApiGatewayNamespace);
    }
    metric4XXErrorCount() {
        return this.metricFactory.createMetric("4XXError", common_1.MetricStatistic.SUM, "4XX Error", this.dimensionsMap, undefined, ApiGatewayNamespace);
    }
    metric4XXErrorRate() {
        const metric = this.metric4XXErrorCount();
        return this.metricFactory.toRate(metric, this.rateComputationMethod, false, "errors");
    }
    metric5XXFaultCount() {
        return this.metricFactory.createMetric("5XXError", common_1.MetricStatistic.SUM, "5XX Fault", this.dimensionsMap, undefined, ApiGatewayNamespace);
    }
    metric5XXFaultRate() {
        const metric = this.metric5XXFaultCount();
        return this.metricFactory.toRate(metric, this.rateComputationMethod, false, "faults");
    }
    /**
     * @deprecated use metricLatencyInMillis instead
     */
    metricLatencyP99InMillis() {
        return this.metricLatencyInMillis(common_1.LatencyType.P99);
    }
    /**
     * @deprecated use metricLatencyInMillis instead
     */
    metricLatencyP90InMillis() {
        return this.metricLatencyInMillis(common_1.LatencyType.P90);
    }
    /**
     * @deprecated use metricLatencyInMillis instead
     */
    metricLatencyP50InMillis() {
        return this.metricLatencyInMillis(common_1.LatencyType.P50);
    }
    metricLatencyInMillis(latencyType) {
        const label = common_1.getLatencyTypeLabel(latencyType);
        return this.metricFactory.createMetric("Latency", common_1.getLatencyTypeStatistic(latencyType), label, this.dimensionsMap, undefined, ApiGatewayNamespace);
    }
}
exports.ApiGatewayMetricFactory = ApiGatewayMetricFactory;
_a = JSII_RTTI_SYMBOL_1;
ApiGatewayMetricFactory[_a] = { fqn: "cdk-monitoring-constructs.ApiGatewayMetricFactory", version: "1.21.0" };
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"ApiGatewayMetricFactory.js","sourceRoot":"","sources":["ApiGatewayMetricFactory.ts"],"names":[],"mappings":";;;;;AAGA,yCAOsB;AAEtB,MAAM,mBAAmB,GAAG,gBAAgB,CAAC;AA6B7C,MAAa,uBAAuB;IAMlC,YACE,aAA4B,EAC5B,KAAmC;QAEnC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC;QACzD,IAAI,CAAC,qBAAqB;YACxB,KAAK,CAAC,qBAAqB,IAAI,8BAAqB,CAAC,OAAO,CAAC;QAC/D,IAAI,CAAC,aAAa,GAAG;YACnB,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,WAAW;YAC9B,KAAK,EAAE,KAAK,CAAC,QAAQ,IAAI,MAAM;YAC/B,GAAG,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;YACnD,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;SAC1D,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC9B,IAAI,CAAC,qBAAqB,EAAE,EAC5B,8BAAqB,CAAC,UAAU,EAChC,KAAK,EACL,UAAU,EACV,IAAI,CAAC,iBAAiB,CACvB,CAAC;IACJ,CAAC;IAED,oBAAoB;QAClB,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC9B,IAAI,CAAC,qBAAqB,EAAE,EAC5B,IAAI,CAAC,qBAAqB,EAC1B,KAAK,EACL,UAAU,EACV,IAAI,CAAC,iBAAiB,CACvB,CAAC;IACJ,CAAC;IAED,qBAAqB;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CACpC,OAAO,EACP,wBAAe,CAAC,GAAG,EACnB,OAAO,EACP,IAAI,CAAC,aAAa,EAClB,SAAS,EACT,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CACpC,UAAU,EACV,wBAAe,CAAC,GAAG,EACnB,WAAW,EACX,IAAI,CAAC,aAAa,EAClB,SAAS,EACT,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,kBAAkB;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC9B,MAAM,EACN,IAAI,CAAC,qBAAqB,EAC1B,KAAK,EACL,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CACpC,UAAU,EACV,wBAAe,CAAC,GAAG,EACnB,WAAW,EACX,IAAI,CAAC,aAAa,EAClB,SAAS,EACT,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,kBAAkB;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC9B,MAAM,EACN,IAAI,CAAC,qBAAqB,EAC1B,KAAK,EACL,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,wBAAwB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC,oBAAW,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,wBAAwB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC,oBAAW,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,wBAAwB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC,oBAAW,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,qBAAqB,CAAC,WAAwB;QAC5C,MAAM,KAAK,GAAG,4BAAmB,CAAC,WAAW,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CACpC,SAAS,EACT,gCAAuB,CAAC,WAAW,CAAC,EACpC,KAAK,EACL,IAAI,CAAC,aAAa,EAClB,SAAS,EACT,mBAAmB,CACpB,CAAC;IACJ,CAAC;;AAjIH,0DAkIC","sourcesContent":["import { RestApiBase } from \"aws-cdk-lib/aws-apigateway\";\nimport { DimensionsMap } from \"aws-cdk-lib/aws-cloudwatch\";\n\nimport {\n  getLatencyTypeLabel,\n  getLatencyTypeStatistic,\n  LatencyType,\n  MetricFactory,\n  MetricStatistic,\n  RateComputationMethod,\n} from \"../../common\";\n\nconst ApiGatewayNamespace = \"AWS/ApiGateway\";\n\nexport interface ApiGatewayMetricFactoryProps {\n  /**\n   * API to monitor (cannot use IRestApi, since it does not provide API name)\n   */\n  readonly api: RestApiBase;\n  /**\n   * @default - prod\n   */\n  readonly apiStage?: string;\n  /**\n   * On undefined value is not set in dimensions\n   */\n  readonly apiMethod?: string;\n  /**\n   * On undefined value is not set in dimensions\n   */\n  readonly apiResource?: string;\n  /**\n   * @default - true\n   */\n  readonly fillTpsWithZeroes?: boolean;\n  /**\n   * @default - average\n   */\n  readonly rateComputationMethod?: RateComputationMethod;\n}\n\nexport class ApiGatewayMetricFactory {\n  protected readonly metricFactory: MetricFactory;\n  protected readonly fillTpsWithZeroes: boolean;\n  protected readonly rateComputationMethod: RateComputationMethod;\n  protected readonly dimensionsMap: DimensionsMap;\n\n  constructor(\n    metricFactory: MetricFactory,\n    props: ApiGatewayMetricFactoryProps\n  ) {\n    this.metricFactory = metricFactory;\n    this.fillTpsWithZeroes = props.fillTpsWithZeroes ?? true;\n    this.rateComputationMethod =\n      props.rateComputationMethod ?? RateComputationMethod.AVERAGE;\n    this.dimensionsMap = {\n      ApiName: props.api.restApiName,\n      Stage: props.apiStage ?? \"prod\",\n      ...(props.apiMethod && { Method: props.apiMethod }),\n      ...(props.apiResource && { Resource: props.apiResource }),\n    };\n  }\n\n  /**\n   * @deprecated use metricInvocationRate\n   */\n  metricTps() {\n    return this.metricFactory.toRate(\n      this.metricInvocationCount(),\n      RateComputationMethod.PER_SECOND,\n      false,\n      \"requests\",\n      this.fillTpsWithZeroes\n    );\n  }\n\n  metricInvocationRate() {\n    return this.metricFactory.toRate(\n      this.metricInvocationCount(),\n      this.rateComputationMethod,\n      false,\n      \"requests\",\n      this.fillTpsWithZeroes\n    );\n  }\n\n  metricInvocationCount() {\n    return this.metricFactory.createMetric(\n      \"Count\",\n      MetricStatistic.SUM,\n      \"Count\",\n      this.dimensionsMap,\n      undefined,\n      ApiGatewayNamespace\n    );\n  }\n\n  metric4XXErrorCount() {\n    return this.metricFactory.createMetric(\n      \"4XXError\",\n      MetricStatistic.SUM,\n      \"4XX Error\",\n      this.dimensionsMap,\n      undefined,\n      ApiGatewayNamespace\n    );\n  }\n\n  metric4XXErrorRate() {\n    const metric = this.metric4XXErrorCount();\n    return this.metricFactory.toRate(\n      metric,\n      this.rateComputationMethod,\n      false,\n      \"errors\"\n    );\n  }\n\n  metric5XXFaultCount() {\n    return this.metricFactory.createMetric(\n      \"5XXError\",\n      MetricStatistic.SUM,\n      \"5XX Fault\",\n      this.dimensionsMap,\n      undefined,\n      ApiGatewayNamespace\n    );\n  }\n\n  metric5XXFaultRate() {\n    const metric = this.metric5XXFaultCount();\n    return this.metricFactory.toRate(\n      metric,\n      this.rateComputationMethod,\n      false,\n      \"faults\"\n    );\n  }\n\n  /**\n   * @deprecated use metricLatencyInMillis instead\n   */\n  metricLatencyP99InMillis() {\n    return this.metricLatencyInMillis(LatencyType.P99);\n  }\n\n  /**\n   * @deprecated use metricLatencyInMillis instead\n   */\n  metricLatencyP90InMillis() {\n    return this.metricLatencyInMillis(LatencyType.P90);\n  }\n\n  /**\n   * @deprecated use metricLatencyInMillis instead\n   */\n  metricLatencyP50InMillis() {\n    return this.metricLatencyInMillis(LatencyType.P50);\n  }\n\n  metricLatencyInMillis(latencyType: LatencyType) {\n    const label = getLatencyTypeLabel(latencyType);\n    return this.metricFactory.createMetric(\n      \"Latency\",\n      getLatencyTypeStatistic(latencyType),\n      label,\n      this.dimensionsMap,\n      undefined,\n      ApiGatewayNamespace\n    );\n  }\n}\n"]}