@cdklabs/multi-az-observability 0.0.1-alpha.34 → 0.0.1-alpha.36

package/.jsii

@@ -4414,7 +4414,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 253
+            "line": 249
           },
           "name": "allAvailabilityZoneIdsAsArray",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4433,7 +4433,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 244
+            "line": 240
           },
           "name": "allAvailabilityZoneIdsAsCommaDelimitedList",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4452,7 +4452,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 273
+            "line": 269
           },
           "name": "allAvailabilityZoneNamesAsCommaDelimitedList",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4470,7 +4470,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 181
+            "line": 177
           },
           "name": "availabilityZoneId",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4496,7 +4496,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 263
+            "line": 259
           },
           "name": "availabilityZoneIdFromAvailabilityZoneLetter",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4522,7 +4522,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 209
+            "line": 205
           },
           "name": "availabilityZoneIdsAsArray",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4559,7 +4559,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 226
+            "line": 222
           },
           "name": "availabilityZoneIdsAsCommaDelimitedList",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4590,7 +4590,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 190
+            "line": 186
           },
           "name": "availabilityZoneName",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -4616,7 +4616,7 @@
           },
           "locationInModule": {
             "filename": "src/azmapper/AvailabilityZoneMapper.ts",
-            "line": 199
+            "line": 195
           },
           "name": "regionPrefixForAvailabilityZoneIds",
           "overrides": "@cdklabs/multi-az-observability.IAvailabilityZoneMapper",
@@ -7342,13 +7342,28 @@
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "An alarm for fault count exceeding a regional threshold for all critical operations."
+            "summary": "An alarm indicating there is availability or latency impact on a critical operation that is not scoped to a single availability zone as measured by the server-side and/or canary (if present)."
           },
           "locationInModule": {
             "filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
-            "line": 43
+            "line": 40
+          },
+          "name": "regionalImpactAlarm",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "An alarm indicating there is availability or latency impact on a critical operation that is not scoped to a single availability zone as measured by the server-side."
           },
-          "name": "regionalFaultCountServerSideAlarm",
+          "locationInModule": {
+            "filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
+            "line": 46
+          },
+          "name": "regionalServerSideImpactAlarm",
           "type": {
             "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
           }
@@ -7368,6 +7383,22 @@
             "fqn": "@cdklabs/multi-az-observability.IService"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "It triggers\non any impact to a critical operation either zonally scoped or regionally scoped.",
+            "stability": "experimental",
+            "summary": "This is the top level alarm you should tie notifications/paging/alerting to."
+          },
+          "locationInModule": {
+            "filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
+            "line": 52
+          },
+          "name": "serviceImpactAlarm",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -7392,7 +7423,7 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "There is 1 alarm per AZ that triggers\non availability or atency impact to any critical operation in that AZ. These are useful\nfor deployment monitoring to not inadvertently fail when a canary can't contact an AZ\nduring a deployment.",
+            "remarks": "There is 1 alarm per AZ that triggers\non availability or latency impact to any critical operation in that AZ. These are useful\nfor deployment monitoring to not inadvertently fail when a canary can't contact an AZ\nduring a deployment.",
             "stability": "experimental",
             "summary": "The zonal server-side isolated impact alarms."
           },
@@ -7414,29 +7445,13 @@
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "An alarm for regional availability impact of any critical operation as measured by the canary."
+            "summary": "An alarm indicating the canary has discovered an availability or latency impact on a critical operation while testing the regional endpoint."
           },
           "locationInModule": {
             "filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
-            "line": 38
-          },
-          "name": "regionalAvailabilityCanaryAlarm",
-          "optional": true,
-          "type": {
-            "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "experimental",
-            "summary": "An alarm for regional availability or latency impact of any critical operation as measured by the canary."
-          },
-          "locationInModule": {
-            "filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
-            "line": 33
+            "line": 34
           },
-          "name": "regionalAvailabilityOrLatencyCanaryAlarm",
+          "name": "regionalCanaryAlarm",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
@@ -7955,7 +7970,7 @@
           "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: 2\nIQR: 1.5\nMAD: 3",
+            "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."
           },
@@ -10387,6 +10402,6 @@
       "symbolId": "src/services/props/ServiceProps:ServiceProps"
     }
   },
-  "version": "0.0.1-alpha.34",
-  "fingerprint": "aKp4DM9gnD7DGI8TTLCtrtzOAehmBkttZQ0qD34S4vA="
+  "version": "0.0.1-alpha.36",
+  "fingerprint": "fi25O9TgC6vdI8X8T1IFXrQy0PhDUFqy/9L/xaRDe6k="
 }

package/API.md

@@ -1517,7 +1517,7 @@ standard for Z_SCORE.
 Standard defaults based on the outlier detection algorithm:
 STATIC: 0.7
 CHI_SQUARED: 0.05
-Z_SCORE: 2
+Z_SCORE: 3
 IQR: 1.5
 MAD: 3
 
@@ -4893,24 +4893,37 @@ Service level alarms and rules using critical operations.
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalFaultCountServerSideAlarm">regionalFaultCountServerSideAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | An alarm for fault count exceeding a regional threshold for all critical operations. |
+| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalImpactAlarm">regionalImpactAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | An alarm indicating there is availability or latency impact on a critical operation that is not scoped to a single availability zone as measured by the server-side and/or canary (if present). |
+| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalServerSideImpactAlarm">regionalServerSideImpactAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | An alarm indicating there is availability or latency impact on a critical operation that is not scoped to a single availability zone as measured by the server-side. |
 | <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.service">service</a></code> | <code><a href="#@cdklabs/multi-az-observability.IService">IService</a></code> | The service these alarms and rules are for. |
+| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.serviceImpactAlarm">serviceImpactAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | This is the top level alarm you should tie notifications/paging/alerting to. |
 | <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.zonalAggregateIsolatedImpactAlarms">zonalAggregateIsolatedImpactAlarms</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_cloudwatch.IAlarm}</code> | The zonal aggregate isolated impact alarms. |
 | <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.zonalServerSideIsolatedImpactAlarms">zonalServerSideIsolatedImpactAlarms</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_cloudwatch.IAlarm}</code> | The zonal server-side isolated impact alarms. |
-| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalAvailabilityCanaryAlarm">regionalAvailabilityCanaryAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | An alarm for regional availability impact of any critical operation as measured by the canary. |
-| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalAvailabilityOrLatencyCanaryAlarm">regionalAvailabilityOrLatencyCanaryAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | An alarm for regional availability or latency impact of any critical operation as measured by the canary. |
+| <code><a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalCanaryAlarm">regionalCanaryAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | An alarm indicating the canary has discovered an availability or latency impact on a critical operation while testing the regional endpoint. |
 
 ---
 
-##### `regionalFaultCountServerSideAlarm`<sup>Required</sup> <a name="regionalFaultCountServerSideAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalFaultCountServerSideAlarm"></a>
+##### `regionalImpactAlarm`<sup>Required</sup> <a name="regionalImpactAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalImpactAlarm"></a>
 
 ```typescript
-public readonly regionalFaultCountServerSideAlarm: IAlarm;
+public readonly regionalImpactAlarm: IAlarm;
 ```
 
 - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
 
-An alarm for fault count exceeding a regional threshold for all critical operations.
+An alarm indicating there is availability or latency impact on a critical operation that is not scoped to a single availability zone as measured by the server-side and/or canary (if present).
+
+---
+
+##### `regionalServerSideImpactAlarm`<sup>Required</sup> <a name="regionalServerSideImpactAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalServerSideImpactAlarm"></a>
+
+```typescript
+public readonly regionalServerSideImpactAlarm: IAlarm;
+```
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
+
+An alarm indicating there is availability or latency impact on a critical operation that is not scoped to a single availability zone as measured by the server-side.
 
 ---
 
@@ -4926,6 +4939,21 @@ The service these alarms and rules are for.
 
 ---
 
+##### `serviceImpactAlarm`<sup>Required</sup> <a name="serviceImpactAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.serviceImpactAlarm"></a>
+
+```typescript
+public readonly serviceImpactAlarm: IAlarm;
+```
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
+
+This is the top level alarm you should tie notifications/paging/alerting to.
+
+It triggers
+on any impact to a critical operation either zonally scoped or regionally scoped.
+
+---
+
 ##### `zonalAggregateIsolatedImpactAlarms`<sup>Required</sup> <a name="zonalAggregateIsolatedImpactAlarms" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.zonalAggregateIsolatedImpactAlarms"></a>
 
 ```typescript
@@ -4953,33 +4981,21 @@ public readonly zonalServerSideIsolatedImpactAlarms: {[ key: string ]: IAlarm};
 The zonal server-side isolated impact alarms.
 
 There is 1 alarm per AZ that triggers
-on availability or atency impact to any critical operation in that AZ. These are useful
+on availability or latency impact to any critical operation in that AZ. These are useful
 for deployment monitoring to not inadvertently fail when a canary can't contact an AZ
 during a deployment.
 
 ---
 
-##### `regionalAvailabilityCanaryAlarm`<sup>Optional</sup> <a name="regionalAvailabilityCanaryAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalAvailabilityCanaryAlarm"></a>
-
-```typescript
-public readonly regionalAvailabilityCanaryAlarm: IAlarm;
-```
-
-- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
-
-An alarm for regional availability impact of any critical operation as measured by the canary.
-
----
-
-##### `regionalAvailabilityOrLatencyCanaryAlarm`<sup>Optional</sup> <a name="regionalAvailabilityOrLatencyCanaryAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalAvailabilityOrLatencyCanaryAlarm"></a>
+##### `regionalCanaryAlarm`<sup>Optional</sup> <a name="regionalCanaryAlarm" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules.property.regionalCanaryAlarm"></a>
 
 ```typescript
-public readonly regionalAvailabilityOrLatencyCanaryAlarm: IAlarm;
+public readonly regionalCanaryAlarm: IAlarm;
 ```
 
 - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
 
-An alarm for regional availability or latency impact of any critical operation as measured by the canary.
+An alarm indicating the canary has discovered an availability or latency impact on a critical operation while testing the regional endpoint.
 
 ---