@cdklabs/multi-az-observability 0.0.1-alpha.41 → 0.0.1-alpha.43

package/.jsii

@@ -8,7 +8,7 @@
     ]
   },
   "dependencies": {
-    "aws-cdk-lib": "^2.184.0",
+    "aws-cdk-lib": "^2.187.0",
     "constructs": "^10.0.5"
   },
   "dependencyClosure": {
@@ -942,6 +942,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_cognito_identitypool": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AWS.Cognito.Identitypool"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.cognito.identitypool"
+            },
+            "python": {
+              "module": "aws_cdk.aws_cognito_identitypool"
+            }
+          }
+        },
         "aws-cdk-lib.aws_comprehend": {
           "targets": {
             "dotnet": {
@@ -3256,6 +3269,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_scheduler_targets": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AWS.Scheduler.Targets"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.scheduler.targets"
+            },
+            "python": {
+              "module": "aws_cdk.aws_scheduler_targets"
+            }
+          }
+        },
         "aws-cdk-lib.aws_sdb": {
           "targets": {
             "dotnet": {
@@ -3913,7 +3939,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/cdklabs/cdk-multi-az-observability",
-  "jsiiVersion": "5.5.26 (build adcbaf3)",
+  "jsiiVersion": "5.5.27 (build f682ef9)",
   "keywords": [
     "aws-cdk",
     "cdk",
@@ -8598,7 +8624,7 @@
         },
         "locationInModule": {
           "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-          "line": 351
+          "line": 352
         },
         "parameters": [
           {
@@ -8627,7 +8653,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-        "line": 37
+        "line": 38
       },
       "name": "InstrumentedServiceMultiAZObservability",
       "properties": [
@@ -8639,7 +8665,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-            "line": 45
+            "line": 46
           },
           "name": "perOperationAlarmsAndRules",
           "overrides": "@cdklabs/multi-az-observability.IInstrumentedServiceMultiAZObservability",
@@ -8661,7 +8687,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-            "line": 55
+            "line": 56
           },
           "name": "perOperationZonalImpactAlarms",
           "overrides": "@cdklabs/multi-az-observability.IInstrumentedServiceMultiAZObservability",
@@ -8687,7 +8713,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-            "line": 62
+            "line": 63
           },
           "name": "serviceAlarms",
           "overrides": "@cdklabs/multi-az-observability.IInstrumentedServiceMultiAZObservability",
@@ -8704,7 +8730,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-            "line": 85
+            "line": 86
           },
           "name": "canaryLogGroup",
           "optional": true,
@@ -8721,7 +8747,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-            "line": 67
+            "line": 68
           },
           "name": "operationDashboards",
           "optional": true,
@@ -8743,7 +8769,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
-            "line": 72
+            "line": 73
           },
           "name": "serviceDashboard",
           "optional": true,
@@ -8766,26 +8792,10 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-        "line": 11
+        "line": 12
       },
       "name": "InstrumentedServiceMultiAZObservabilityProps",
       "properties": [
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "experimental",
-            "summary": "The algorithm to use for performing outlier detection."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 52
-          },
-          "name": "outlierDetectionAlgorithm",
-          "type": {
-            "fqn": "@cdklabs/multi-az-observability.OutlierDetectionAlgorithm"
-          }
-        },
         {
           "abstract": true,
           "docs": {
@@ -8795,7 +8805,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 15
+            "line": 16
           },
           "name": "service",
           "type": {
@@ -8813,7 +8823,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 76
+            "line": 124
           },
           "name": "assetsBucketParameterName",
           "optional": true,
@@ -8832,7 +8842,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 96
+            "line": 144
           },
           "name": "assetsBucketPrefixParameterName",
           "optional": true,
@@ -8840,6 +8850,44 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "OutlierDetectionAlgorithm.STATIC",
+            "remarks": "** Currently only STATIC is supported **",
+            "stability": "experimental",
+            "summary": "The algorithm to use for performing outlier detection for availability metrics."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
+            "line": 57
+          },
+          "name": "availabilityOutlierDetectionAlgorithm",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.OutlierDetectionAlgorithm"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Depends on the outlier detection algorithm selected",
+            "remarks": "This number is interpreted\ndifferently for different outlier algorithms. When used with\nSTATIC, the number should be between 0 and 1 to represent the\npercentage of errors (like .7) that an AZ must be responsible\nfor to be considered an outlier. When used with CHI_SQUARED, it\nrepresents the p value that indicates statistical significance, like\n0.05 which means the skew has less than or equal to a 5% chance of\noccuring. When used with Z_SCORE it indicates how many standard\ndeviations to evaluate for an AZ being an outlier, typically 3 is\nstandard for Z_SCORE.\n\nStandard defaults based on the outlier detection algorithm:\nSTATIC: 0.7\nCHI_SQUARED: 0.05\nZ_SCORE: 3\nIQR: 1.5\nMAD: 3",
+            "stability": "experimental",
+            "summary": "The outlier threshold for determining if an AZ is an outlier for faults."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
+            "line": 48
+          },
+          "name": "availabilityOutlierThreshold",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -8850,7 +8898,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 23
+            "line": 24
           },
           "name": "createDashboards",
           "optional": true,
@@ -8868,7 +8916,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 60
+            "line": 108
           },
           "name": "interval",
           "optional": true,
@@ -8876,20 +8924,57 @@
             "fqn": "aws-cdk-lib.Duration"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "OutlierDetectionAlgorithm.STATIC",
+            "remarks": "** Currently only STATIC is supported **",
+            "stability": "experimental",
+            "summary": "The algorithm to use for performing outlier detection for latency metrics."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
+            "line": 90
+          },
+          "name": "latencyOutlierDetectionAlgorithm",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.OutlierDetectionAlgorithm"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "LatencyOutlierMetric.COUNT",
+            "stability": "experimental",
+            "summary": "The metric for latency to use in outlier detection, which means whether the algorithm uses a count of requests exceeding your latency threshold or whether it uses the actual latency values at your latency alarm threshold statistic."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
+            "line": 100
+          },
+          "name": "latencyOutlierMetricAggregation",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation"
+          }
+        },
         {
           "abstract": true,
           "docs": {
             "default": "- Depends on the outlier detection algorithm selected",
             "remarks": "This number is interpreted\ndifferently for different outlier algorithms. When used with\nSTATIC, the number should be between 0 and 1 to represent the\npercentage of errors (like .7) that an AZ must be responsible\nfor to be considered an outlier. When used with CHI_SQUARED, it\nrepresents the p value that indicates statistical significance, like\n0.05 which means the skew has less than or equal to a 5% chance of\noccuring. When used with Z_SCORE it indicates how many standard\ndeviations to evaluate for an AZ being an outlier, typically 3 is\nstandard for Z_SCORE.\n\nStandard defaults based on the outlier detection algorithm:\nSTATIC: 0.7\nCHI_SQUARED: 0.05\nZ_SCORE: 3\nIQR: 1.5\nMAD: 3",
             "stability": "experimental",
-            "summary": "The outlier threshold for determining if an AZ is an outlier for latency or faults."
+            "summary": "The outlier threshold for determining if an AZ is an outlier for latency."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/InstrumentedServiceMultiAZObservabilityProps.ts",
-            "line": 47
+            "line": 81
           },
-          "name": "outlierThreshold",
+          "name": "latencyOutlierThreshold",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -8898,6 +8983,39 @@
       ],
       "symbolId": "src/services/props/InstrumentedServiceMultiAZObservabilityProps:InstrumentedServiceMultiAZObservabilityProps"
     },
+    "@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation": {
+      "assembly": "@cdklabs/multi-az-observability",
+      "docs": {
+        "stability": "experimental",
+        "summary": "The latency metric aggregation to use for latency outlier detection."
+      },
+      "fqn": "@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/outlier-detection/LatencyOutlierMetricAggregation.ts",
+        "line": 4
+      },
+      "members": [
+        {
+          "docs": {
+            "remarks": "This option works\nwith all outlier detection algorithms",
+            "stability": "experimental",
+            "summary": "This option will use the count of the number of requests exceeding a latency threshold to make an outlier comparison."
+          },
+          "name": "COUNT"
+        },
+        {
+          "docs": {
+            "remarks": "For example,\nAZ1: p99 = 125ms\nAZ2: p99 = 130ms\nAZ3: p99 = 250ms\n\nThese values will be compared using the provided outlier detection algorithm. This\noption is not compatible with the STATIC outlier detection algorithm.",
+            "stability": "experimental",
+            "summary": "This option will use the value of your provided latency statistic, like p99, and the value of the latency in each AZ will be compared."
+          },
+          "name": "VALUE"
+        }
+      ],
+      "name": "LatencyOutlierMetricAggregation",
+      "symbolId": "src/outlier-detection/LatencyOutlierMetricAggregation:LatencyOutlierMetricAggregation"
+    },
     "@cdklabs/multi-az-observability.MetricDimensions": {
       "assembly": "@cdklabs/multi-az-observability",
       "docs": {
@@ -11628,6 +11746,6 @@
       "symbolId": "src/services/props/ServiceProps:ServiceProps"
     }
   },
-  "version": "0.0.1-alpha.41",
-  "fingerprint": "Vxj8ZrNtuSp+kaHwEZQ+5UtmgvKeKlCCSKgTrD1ZnQ4="
+  "version": "0.0.1-alpha.43",
+  "fingerprint": "6DGDr/sgSWsgfrdimRlKhEYUrbBIi5u9dYQI5OgLtiM="
 }

package/API.md

@@ -1570,25 +1570,16 @@ const instrumentedServiceMultiAZObservabilityProps: InstrumentedServiceMultiAZOb
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.outlierDetectionAlgorithm">outlierDetectionAlgorithm</a></code> | <code><a href="#@cdklabs/multi-az-observability.OutlierDetectionAlgorithm">OutlierDetectionAlgorithm</a></code> | The algorithm to use for performing outlier detection. |
 | <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.service">service</a></code> | <code><a href="#@cdklabs/multi-az-observability.IService">IService</a></code> | The service that the alarms and dashboards are being crated for. |
 | <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.assetsBucketParameterName">assetsBucketParameterName</a></code> | <code>string</code> | If you are not using a static bucket to deploy assets, for example you are synthing this and it gets uploaded to a bucket whose name is unknown to you (maybe used as part of a central CI/CD system) and is provided as a parameter to your stack, specify that parameter name here. |
 | <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.assetsBucketPrefixParameterName">assetsBucketPrefixParameterName</a></code> | <code>string</code> | If you are not using a static bucket to deploy assets, for example you are synthing this and it gets uploaded to a bucket that uses a prefix that is unknown to you (maybe used as part of a central CI/CD system) and is provided as a parameter to your stack, specify that parameter name here. |
+| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.availabilityOutlierDetectionAlgorithm">availabilityOutlierDetectionAlgorithm</a></code> | <code><a href="#@cdklabs/multi-az-observability.OutlierDetectionAlgorithm">OutlierDetectionAlgorithm</a></code> | The algorithm to use for performing outlier detection for availability metrics. |
+| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.availabilityOutlierThreshold">availabilityOutlierThreshold</a></code> | <code>number</code> | The outlier threshold for determining if an AZ is an outlier for faults. |
 | <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.createDashboards">createDashboards</a></code> | <code>boolean</code> | Indicates whether to create per operation and overall service dashboards. |
 | <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.interval">interval</a></code> | <code>aws-cdk-lib.Duration</code> | The interval used in the dashboard, defaults to 60 minutes. |
-| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.outlierThreshold">outlierThreshold</a></code> | <code>number</code> | The outlier threshold for determining if an AZ is an outlier for latency or faults. |
-
----
-
-##### `outlierDetectionAlgorithm`<sup>Required</sup> <a name="outlierDetectionAlgorithm" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.outlierDetectionAlgorithm"></a>
-
-```typescript
-public readonly outlierDetectionAlgorithm: OutlierDetectionAlgorithm;
-```
-
-- *Type:* <a href="#@cdklabs/multi-az-observability.OutlierDetectionAlgorithm">OutlierDetectionAlgorithm</a>
-
-The algorithm to use for performing outlier detection.
+| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.latencyOutlierDetectionAlgorithm">latencyOutlierDetectionAlgorithm</a></code> | <code><a href="#@cdklabs/multi-az-observability.OutlierDetectionAlgorithm">OutlierDetectionAlgorithm</a></code> | The algorithm to use for performing outlier detection for latency metrics. |
+| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.latencyOutlierMetricAggregation">latencyOutlierMetricAggregation</a></code> | <code><a href="#@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation">LatencyOutlierMetricAggregation</a></code> | The metric for latency to use in outlier detection, which means whether the algorithm uses a count of requests exceeding your latency threshold or whether it uses the actual latency values at your latency alarm threshold statistic. |
+| <code><a href="#@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.latencyOutlierThreshold">latencyOutlierThreshold</a></code> | <code>number</code> | The outlier threshold for determining if an AZ is an outlier for latency. |
 
 ---
 
@@ -1643,6 +1634,52 @@ value for this property.
 
 ---
 
+##### `availabilityOutlierDetectionAlgorithm`<sup>Optional</sup> <a name="availabilityOutlierDetectionAlgorithm" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.availabilityOutlierDetectionAlgorithm"></a>
+
+```typescript
+public readonly availabilityOutlierDetectionAlgorithm: OutlierDetectionAlgorithm;
+```
+
+- *Type:* <a href="#@cdklabs/multi-az-observability.OutlierDetectionAlgorithm">OutlierDetectionAlgorithm</a>
+- *Default:* OutlierDetectionAlgorithm.STATIC
+
+The algorithm to use for performing outlier detection for availability metrics.
+
+** Currently only STATIC is supported **
+
+---
+
+##### `availabilityOutlierThreshold`<sup>Optional</sup> <a name="availabilityOutlierThreshold" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.availabilityOutlierThreshold"></a>
+
+```typescript
+public readonly availabilityOutlierThreshold: number;
+```
+
+- *Type:* number
+- *Default:* Depends on the outlier detection algorithm selected
+
+The outlier threshold for determining if an AZ is an outlier for faults.
+
+This number is interpreted
+differently for different outlier algorithms. When used with
+STATIC, the number should be between 0 and 1 to represent the
+percentage of errors (like .7) that an AZ must be responsible
+for to be considered an outlier. When used with CHI_SQUARED, it
+represents the p value that indicates statistical significance, like
+0.05 which means the skew has less than or equal to a 5% chance of
+occuring. When used with Z_SCORE it indicates how many standard
+deviations to evaluate for an AZ being an outlier, typically 3 is
+standard for Z_SCORE.
+
+Standard defaults based on the outlier detection algorithm:
+STATIC: 0.7
+CHI_SQUARED: 0.05
+Z_SCORE: 3
+IQR: 1.5
+MAD: 3
+
+---
+
 ##### `createDashboards`<sup>Optional</sup> <a name="createDashboards" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.createDashboards"></a>
 
 ```typescript
@@ -1669,16 +1706,44 @@ The interval used in the dashboard, defaults to 60 minutes.
 
 ---
 
-##### `outlierThreshold`<sup>Optional</sup> <a name="outlierThreshold" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.outlierThreshold"></a>
+##### `latencyOutlierDetectionAlgorithm`<sup>Optional</sup> <a name="latencyOutlierDetectionAlgorithm" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.latencyOutlierDetectionAlgorithm"></a>
+
+```typescript
+public readonly latencyOutlierDetectionAlgorithm: OutlierDetectionAlgorithm;
+```
+
+- *Type:* <a href="#@cdklabs/multi-az-observability.OutlierDetectionAlgorithm">OutlierDetectionAlgorithm</a>
+- *Default:* OutlierDetectionAlgorithm.STATIC
+
+The algorithm to use for performing outlier detection for latency metrics.
+
+** Currently only STATIC is supported **
+
+---
+
+##### `latencyOutlierMetricAggregation`<sup>Optional</sup> <a name="latencyOutlierMetricAggregation" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.latencyOutlierMetricAggregation"></a>
 
 ```typescript
-public readonly outlierThreshold: number;
+public readonly latencyOutlierMetricAggregation: LatencyOutlierMetricAggregation;
+```
+
+- *Type:* <a href="#@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation">LatencyOutlierMetricAggregation</a>
+- *Default:* LatencyOutlierMetric.COUNT
+
+The metric for latency to use in outlier detection, which means whether the algorithm uses a count of requests exceeding your latency threshold or whether it uses the actual latency values at your latency alarm threshold statistic.
+
+---
+
+##### `latencyOutlierThreshold`<sup>Optional</sup> <a name="latencyOutlierThreshold" id="@cdklabs/multi-az-observability.InstrumentedServiceMultiAZObservabilityProps.property.latencyOutlierThreshold"></a>
+
+```typescript
+public readonly latencyOutlierThreshold: number;
 ```
 
 - *Type:* number
 - *Default:* Depends on the outlier detection algorithm selected
 
-The outlier threshold for determining if an AZ is an outlier for latency or faults.
+The outlier threshold for determining if an AZ is an outlier for latency.
 
 This number is interpreted
 differently for different outlier algorithms. When used with
@@ -8574,6 +8639,44 @@ average for all AZs. This is the default.
 ---
 
 
+### LatencyOutlierMetricAggregation <a name="LatencyOutlierMetricAggregation" id="@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation"></a>
+
+The latency metric aggregation to use for latency outlier detection.
+
+#### Members <a name="Members" id="Members"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation.COUNT">COUNT</a></code> | This option will use the count of the number of requests exceeding a latency threshold to make an outlier comparison. |
+| <code><a href="#@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation.VALUE">VALUE</a></code> | This option will use the value of your provided latency statistic, like p99, and the value of the latency in each AZ will be compared. |
+
+---
+
+##### `COUNT` <a name="COUNT" id="@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation.COUNT"></a>
+
+This option will use the count of the number of requests exceeding a latency threshold to make an outlier comparison.
+
+This option works
+with all outlier detection algorithms
+
+---
+
+
+##### `VALUE` <a name="VALUE" id="@cdklabs/multi-az-observability.LatencyOutlierMetricAggregation.VALUE"></a>
+
+This option will use the value of your provided latency statistic, like p99, and the value of the latency in each AZ will be compared.
+
+For example,
+AZ1: p99 = 125ms
+AZ2: p99 = 130ms
+AZ3: p99 = 250ms
+
+These values will be compared using the provided outlier detection algorithm. This
+option is not compatible with the STATIC outlier detection algorithm.
+
+---
+
+
 ### OutlierDetectionAlgorithm <a name="OutlierDetectionAlgorithm" id="@cdklabs/multi-az-observability.OutlierDetectionAlgorithm"></a>
 
 Available algorithms for performing outlier detection.

package/lib/alarmsandrules/AvailabilityAndLatencyAlarmsAndRules.d.ts

@@ -11,6 +11,7 @@ import { IOperationMetricDetails } from '../services/IOperationMetricDetails';
 import { OutlierDetectionAlgorithm } from '../utilities/OutlierDetectionAlgorithm';
 import { IOperationAvailabilityMetricDetails } from '../services/IOperationAvailabilityMetricDetails';
 import { IOperationLatencyMetricDetails } from '../services/IOperationLatencyMetricDetails';
+import { LatencyOutlierMetricAggregation } from '../outlier-detection/LatencyOutlierMetricAggregation';
 /**
  * Class used to create availability and latency alarms and Contributor Insight rules
  */
@@ -77,7 +78,7 @@ export declare class AvailabilityAndLatencyAlarmsAndRules {
     static createZonalFaultRateOutlierAlarmForNatGW(scope: IConstruct, natGateways: {
         [key: string]: CfnNatGateway[];
     }, availabilityZoneId: string, outlierThreshold: number, outlierDetectionFunction: IFunction, outlierDetectionAlgorithm: OutlierDetectionAlgorithm, azMapper: IAvailabilityZoneMapper, counter: number, evaluationPeriods: number, datapointsToAlarm: number, period: Duration, nameSuffix?: string): IAlarm;
-    static createZonalHighLatencyOutlierAlarm(scope: IConstruct, metricDetails: IOperationLatencyMetricDetails, availabilityZoneId: string, allAvailabilityZoneIds: string[], outlierThreshold: number, outlierDetectionFunction: IFunction, outlierDetectionAlgorithm: OutlierDetectionAlgorithm, counter: number, nameSuffix?: string): IAlarm;
+    static createZonalHighLatencyOutlierAlarm(scope: IConstruct, metricDetails: IOperationLatencyMetricDetails, availabilityZoneId: string, allAvailabilityZoneIds: string[], outlierThreshold: number, outlierDetectionFunction: IFunction, outlierMetric: LatencyOutlierMetricAggregation, outlierDetectionAlgorithm: OutlierDetectionAlgorithm, counter: number, nameSuffix?: string): IAlarm;
     static createZonalHighLatencyStaticOutlierAlarm(scope: Construct, metricDetails: IOperationLatencyMetricDetails, availabilityZone: string, availabilityZoneId: string, counter: number, outlierThreshold: number, nameSuffix?: string): IAlarm;
     static createZonalHighLatencyStaticOutlierAlarmForCanaries(scope: Construct, metricDetails: IOperationLatencyMetricDetails, availabilityZone: string, availabilityZoneId: string, availabilityZones: string[], counter: number, outlierThreshold: number, nameSuffix?: string): IAlarm;
     /**