@cdklabs/multi-az-observability 0.0.1-alpha.13 → 0.0.1-alpha.15

package/.jsii

@@ -4142,16 +4142,200 @@
       ],
       "symbolId": "src/canaries/props/AddCanaryTestProps:AddCanaryTestProps"
     },
-    "@cdklabs/multi-az-observability.ApplicationLoadBalancerLatencyOutlierCalculation": {
+    "@cdklabs/multi-az-observability.ApplicationLoadBalancerAvailabilityOutlierAlgorithm": {
+      "assembly": "@cdklabs/multi-az-observability",
+      "docs": {
+        "stability": "experimental",
+        "summary": "The options for calculating if an ALB is an outlier for availability."
+      },
+      "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerAvailabilityOutlierAlgorithm",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/outlier-detection/ApplicationLoadBalancerAvailabilityOutlierAlgorithm.ts",
+        "line": 4
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "This will take the availability threshold and calculate if one AZ is responsible for that percentage of errors."
+          },
+          "name": "STATIC"
+        }
+      ],
+      "name": "ApplicationLoadBalancerAvailabilityOutlierAlgorithm",
+      "symbolId": "src/outlier-detection/ApplicationLoadBalancerAvailabilityOutlierAlgorithm:ApplicationLoadBalancerAvailabilityOutlierAlgorithm"
+    },
+    "@cdklabs/multi-az-observability.ApplicationLoadBalancerDetectionProps": {
+      "assembly": "@cdklabs/multi-az-observability",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "The properties for performing zonal impact detection with ALB(s)."
+      },
+      "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerDetectionProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+        "line": 8
+      },
+      "name": "ApplicationLoadBalancerDetectionProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The application load balancers to collect metrics from."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 13
+          },
+          "name": "applicationLoadBalancers",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "For example\n1% or 5%, 0.01 or 0.05.",
+            "stability": "experimental",
+            "summary": "The percentage of faults for a single ALB to consider an AZ to be unhealthy, this should align with your availability goal."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 20
+          },
+          "name": "faultCountPercentThreshold",
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The statistic used to measure target response latency, like p99,  which can be specified using Stats.percentile(99) or \"p99\"."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 32
+          },
+          "name": "latencyStatistic",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The threshold in milliseconds for ALB targets whose responses are slower than this value at the specified percentile statistic."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 26
+          },
+          "name": "latencyThreshold",
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "STATIC",
+            "stability": "experimental",
+            "summary": "The method used to determine if an AZ is an outlier for availability for Application Load Balancer metrics."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 44
+          },
+          "name": "availabilityOutlierAlgorithm",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerAvailabilityOutlierAlgorithm"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"This depends on the algorithm used. STATIC: 0.66.\"",
+            "stability": "experimental",
+            "summary": "The threshold for the outlier detection algorithm."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 51
+          },
+          "name": "availabilityOutlierThreshold",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Z_SCORE",
+            "stability": "experimental",
+            "summary": "The method used to determine if an AZ is an outlier for latency for Application Load Balancer metrics."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 38
+          },
+          "name": "latencyOutlierAlgorithm",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerLatencyOutlierAlgorithm"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"This depends on the algorithm used. STATIC: 0.66. Z_SCORE: 3.\"",
+            "stability": "experimental",
+            "summary": "The threshold for the outlier detection algorithm."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
+            "line": 58
+          },
+          "name": "latencyOutlierThreshold",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps:ApplicationLoadBalancerDetectionProps"
+    },
+    "@cdklabs/multi-az-observability.ApplicationLoadBalancerLatencyOutlierAlgorithm": {
       "assembly": "@cdklabs/multi-az-observability",
       "docs": {
         "stability": "experimental",
         "summary": "The options for calculating if an AZ is an outlier for latency for ALBs."
       },
-      "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerLatencyOutlierCalculation",
+      "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerLatencyOutlierAlgorithm",
       "kind": "enum",
       "locationInModule": {
-        "filename": "src/basic_observability/props/ApplicationLoadBalancerLatencyOutlierCalculation.ts",
+        "filename": "src/outlier-detection/ApplicationLoadBalancerLatencyOutlierAlgorithm.ts",
         "line": 4
       },
       "members": [
@@ -4172,8 +4356,8 @@
           "name": "Z_SCORE"
         }
       ],
-      "name": "ApplicationLoadBalancerLatencyOutlierCalculation",
-      "symbolId": "src/basic_observability/props/ApplicationLoadBalancerLatencyOutlierCalculation:ApplicationLoadBalancerLatencyOutlierCalculation"
+      "name": "ApplicationLoadBalancerLatencyOutlierAlgorithm",
+      "symbolId": "src/outlier-detection/ApplicationLoadBalancerLatencyOutlierAlgorithm:ApplicationLoadBalancerLatencyOutlierAlgorithm"
     },
     "@cdklabs/multi-az-observability.AvailabilityZoneMapper": {
       "assembly": "@cdklabs/multi-az-observability",
@@ -4548,7 +4732,7 @@
         },
         "locationInModule": {
           "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-          "line": 87
+          "line": 81
         },
         "parameters": [
           {
@@ -4577,7 +4761,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-        "line": 40
+        "line": 34
       },
       "name": "BasicServiceMultiAZObservability",
       "properties": [
@@ -4588,7 +4772,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 75
+            "line": 69
           },
           "name": "aggregateZonalIsolatedImpactAlarms",
           "overrides": "@cdklabs/multi-az-observability.IBasicServiceMultiAZObservability",
@@ -4608,7 +4792,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 57
+            "line": 51
           },
           "name": "serviceName",
           "overrides": "@cdklabs/multi-az-observability.IBasicServiceMultiAZObservability",
@@ -4623,7 +4807,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 69
+            "line": 63
           },
           "name": "albZonalIsolatedImpactAlarms",
           "optional": true,
@@ -4644,7 +4828,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 52
+            "line": 46
           },
           "name": "applicationLoadBalancers",
           "optional": true,
@@ -4665,7 +4849,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 80
+            "line": 74
           },
           "name": "dashboard",
           "optional": true,
@@ -4680,7 +4864,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 47
+            "line": 41
           },
           "name": "natGateways",
           "optional": true,
@@ -4706,7 +4890,7 @@
           },
           "locationInModule": {
             "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
-            "line": 63
+            "line": 57
           },
           "name": "natGWZonalIsolatedImpactAlarms",
           "optional": true,
@@ -4734,7 +4918,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-        "line": 12
+        "line": 11
       },
       "name": "BasicServiceMultiAZObservabilityProps",
       "properties": [
@@ -4747,7 +4931,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 124
+            "line": 93
           },
           "name": "datapointsToAlarm",
           "type": {
@@ -4763,62 +4947,13 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 119
+            "line": 88
           },
           "name": "evaluationPeriods",
           "type": {
             "primitive": "number"
           }
         },
-        {
-          "abstract": true,
-          "docs": {
-            "remarks": "For example\n1% or 5%, specify as 1 or 5.",
-            "stability": "experimental",
-            "summary": "The percentage of faults for a single ALB to consider an AZ to be unhealthy, this should align with your availability goal."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 50
-          },
-          "name": "faultCountPercentageThreshold",
-          "type": {
-            "primitive": "number"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "experimental",
-            "summary": "The statistic used to measure target response latency, like p99,  which can be specified using Stats.percentile(99) or \"p99\"."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 62
-          },
-          "name": "latencyStatistic",
-          "type": {
-            "primitive": "string"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "experimental",
-            "summary": "The threshold in seconds for ALB targets whose responses are slower than this value at the specified percentile statistic."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 56
-          },
-          "name": "latencyThreshold",
-          "type": {
-            "primitive": "number"
-          }
-        },
         {
           "abstract": true,
           "docs": {
@@ -4828,7 +4963,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 35
+            "line": 31
           },
           "name": "serviceName",
           "type": {
@@ -4838,25 +4973,20 @@
         {
           "abstract": true,
           "docs": {
-            "default": "\"No alarms for ALBs will be created\"",
-            "remarks": "There will be an alarm created for \neach AZ for each ALB. Then, there will be a composite alarm for AZ created from the input\nof all ALBs. You must either specify an ALB or a NAT GW.",
+            "default": "\"No ALBs will be used to calculate impact.\"",
+            "remarks": "You must specify this\nand/or natGatewayProps.",
             "stability": "experimental",
-            "summary": "The application load balancers being used by the service."
+            "summary": "Properties for ALBs to detect single AZ impact."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 30
+            "line": 26
           },
-          "name": "applicationLoadBalancers",
+          "name": "applicationLoadBalancerProps",
           "optional": true,
           "type": {
-            "collection": {
-              "elementtype": {
-                "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer"
-              },
-              "kind": "array"
-            }
+            "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerDetectionProps"
           }
         },
         {
@@ -4870,7 +5000,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 98
+            "line": 67
           },
           "name": "assetsBucketParameterName",
           "optional": true,
@@ -4889,7 +5019,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 114
+            "line": 83
           },
           "name": "assetsBucketPrefixParameterName",
           "optional": true,
@@ -4907,7 +5037,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 76
+            "line": 45
           },
           "name": "createDashboard",
           "optional": true,
@@ -4925,7 +5055,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 83
+            "line": 52
           },
           "name": "interval",
           "optional": true,
@@ -4936,66 +5066,20 @@
         {
           "abstract": true,
           "docs": {
-            "default": "Z_SCORE",
-            "stability": "experimental",
-            "summary": "The method used to determine if an AZ is an outlier for latency for Application Load Balancer metrics."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 130
-          },
-          "name": "latencyOutlierCalculation",
-          "optional": true,
-          "type": {
-            "fqn": "@cdklabs/multi-az-observability.ApplicationLoadBalancerLatencyOutlierCalculation"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "default": "\"No alarms for NAT Gateways will be created\"",
-            "remarks": "One alarm per NAT GW will be created. If multiple NAT GWs\nare provided for a single AZ, those alarms will be aggregated into\na composite alarm for the AZ. You must either specify an ALB or a NAT GW.",
-            "stability": "experimental",
-            "summary": "(Optional) A map of Availability Zone name to the NAT Gateways in that AZ."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 21
-          },
-          "name": "natGateways",
-          "optional": true,
-          "type": {
-            "collection": {
-              "elementtype": {
-                "collection": {
-                  "elementtype": {
-                    "fqn": "aws-cdk-lib.aws_ec2.CfnNatGateway"
-                  },
-                  "kind": "array"
-                }
-              },
-              "kind": "map"
-            }
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "default": "\"0.01 (as in 0.01%)\"",
+            "default": "\"No NAT Gateways will be used to calculate impact.\"",
+            "remarks": "You must specify\nthis and/or applicationLoadBalancerProps.",
             "stability": "experimental",
-            "summary": "The amount of packet loss in a NAT GW to determine if an AZ is actually impacted, recommendation is 0.01%."
+            "summary": "Properties for NAT Gateways to detect single AZ impact."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 43
+            "line": 18
           },
-          "name": "packetLossImpactPercentageThreshold",
+          "name": "natGatewayProps",
           "optional": true,
           "type": {
-            "primitive": "number"
+            "fqn": "@cdklabs/multi-az-observability.NatGatewayDetectionProps"
           }
         },
         {
@@ -5008,7 +5092,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 69
+            "line": 38
           },
           "name": "period",
           "optional": true,
@@ -8086,6 +8170,104 @@
       ],
       "symbolId": "src/services/props/MetricDimensions:MetricDimensions"
     },
+    "@cdklabs/multi-az-observability.NatGatewayDetectionProps": {
+      "assembly": "@cdklabs/multi-az-observability",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "The properties for performing zonal impact detection with NAT Gateway(s)."
+      },
+      "fqn": "@cdklabs/multi-az-observability.NatGatewayDetectionProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/basic_observability/props/NatGatewayDetectionProps.ts",
+        "line": 7
+      },
+      "name": "NatGatewayDetectionProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "A list of NAT Gateways per Availability Zone (using the AZ name as the key)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/NatGatewayDetectionProps.ts",
+            "line": 12
+          },
+          "name": "natGateways",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "collection": {
+                  "elementtype": {
+                    "fqn": "aws-cdk-lib.aws_ec2.CfnNatGateway"
+                  },
+                  "kind": "array"
+                }
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "PacketLossOutlierAlgorithm.STATIC",
+            "stability": "experimental",
+            "summary": "The algorithm to use to calculate an AZ as an outlier for packet loss."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/NatGatewayDetectionProps.ts",
+            "line": 26
+          },
+          "name": "packetLossOutlierAlgorithm",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.PacketLossOutlierAlgorithm"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"This depends on the outlier algorithm. STATIC: 0.66. Z-SCORE: 3.\"",
+            "stability": "experimental",
+            "summary": "The threshold used with the outlier calculation."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/NatGatewayDetectionProps.ts",
+            "line": 33
+          },
+          "name": "packetLossOutlierThreshold",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "0.01 (as in 0.01%)",
+            "stability": "experimental",
+            "summary": "The percentage of packet loss at which you consider there to be impact."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/basic_observability/props/NatGatewayDetectionProps.ts",
+            "line": 19
+          },
+          "name": "packetLossPercentThreshold",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/basic_observability/props/NatGatewayDetectionProps:NatGatewayDetectionProps"
+    },
     "@cdklabs/multi-az-observability.NetworkConfigurationProps": {
       "assembly": "@cdklabs/multi-az-observability",
       "datatype": true,
@@ -9275,6 +9457,30 @@
       "name": "OutlierDetectionAlgorithm",
       "symbolId": "src/utilities/OutlierDetectionAlgorithm:OutlierDetectionAlgorithm"
     },
+    "@cdklabs/multi-az-observability.PacketLossOutlierAlgorithm": {
+      "assembly": "@cdklabs/multi-az-observability",
+      "docs": {
+        "stability": "experimental",
+        "summary": "The options for calculating if a NAT Gateway is an outlier for packet loss."
+      },
+      "fqn": "@cdklabs/multi-az-observability.PacketLossOutlierAlgorithm",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/outlier-detection/PacketLossOutlierAlgorithm.ts",
+        "line": 4
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "This will take the availability threshold and calculate if one AZ is responsible for that percentage of packet loss."
+          },
+          "name": "STATIC"
+        }
+      ],
+      "name": "PacketLossOutlierAlgorithm",
+      "symbolId": "src/outlier-detection/PacketLossOutlierAlgorithm:PacketLossOutlierAlgorithm"
+    },
     "@cdklabs/multi-az-observability.Service": {
       "assembly": "@cdklabs/multi-az-observability",
       "docs": {
@@ -10211,6 +10417,6 @@
       "symbolId": "src/services/props/ServiceProps:ServiceProps"
     }
   },
-  "version": "0.0.1-alpha.13",
-  "fingerprint": "F+o/YxPsJvnFVE+4xrymzjq8BCakKvVSgPMh7v9Sgi8="
+  "version": "0.0.1-alpha.15",
+  "fingerprint": "zJKawdwFl2/wC3wCfw1Y5oV6/U/bAUGYBI6CDnLurak="
 }