@cdklabs/multi-az-observability 0.0.0-alpha.0 → 0.0.1-alpha.0

package/.jsii

@@ -3900,7 +3900,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/cdklabs/cdk-multi-az-observability",
-  "jsiiVersion": "5.5.10 (build 224bf90)",
+  "jsiiVersion": "5.5.20 (build d4f0601)",
   "keywords": [
     "aws-cdk",
     "cdk",
@@ -4527,8 +4527,8 @@
           "stability": "experimental"
         },
         "locationInModule": {
-          "filename": "src/services/BasicServiceMultiAZObservability.ts",
-          "line": 99
+          "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+          "line": 86
         },
         "parameters": [
           {
@@ -4556,8 +4556,8 @@
       ],
       "kind": "class",
       "locationInModule": {
-        "filename": "src/services/BasicServiceMultiAZObservability.ts",
-        "line": 42
+        "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+        "line": 39
       },
       "name": "BasicServiceMultiAZObservability",
       "properties": [
@@ -4567,8 +4567,8 @@
             "summary": "The alarms indicating if an AZ has isolated impact from either ALB or NAT GW metrics."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 77
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 74
           },
           "name": "aggregateZonalIsolatedImpactAlarms",
           "overrides": "@cdklabs/multi-az-observability.IBasicServiceMultiAZObservability",
@@ -4587,8 +4587,8 @@
             "summary": "The name of the service."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 59
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 56
           },
           "name": "serviceName",
           "overrides": "@cdklabs/multi-az-observability.IBasicServiceMultiAZObservability",
@@ -4602,8 +4602,8 @@
             "summary": "The alarms indicating if an AZ is an outlier for ALB faults and has isolated impact."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 71
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 68
           },
           "name": "albZonalIsolatedImpactAlarms",
           "optional": true,
@@ -4623,8 +4623,8 @@
             "summary": "The application load balancers being used by the service."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 54
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 51
           },
           "name": "applicationLoadBalancers",
           "optional": true,
@@ -4644,8 +4644,8 @@
             "summary": "The dashboard that is optionally created."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 82
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 79
           },
           "name": "dashboard",
           "optional": true,
@@ -4659,8 +4659,8 @@
             "summary": "The NAT Gateways being used in the service, each set of NAT Gateways are keyed by their Availability Zone Id."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 49
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 46
           },
           "name": "natGateways",
           "optional": true,
@@ -4685,8 +4685,8 @@
             "summary": "The alarms indicating if an AZ is an outlier for NAT GW packet loss and has isolated impact."
           },
           "locationInModule": {
-            "filename": "src/services/BasicServiceMultiAZObservability.ts",
-            "line": 65
+            "filename": "src/basic_observability/BasicServiceMultiAZObservability.ts",
+            "line": 62
           },
           "name": "natGWZonalIsolatedImpactAlarms",
           "optional": true,
@@ -4701,19 +4701,19 @@
           }
         }
       ],
-      "symbolId": "src/services/BasicServiceMultiAZObservability:BasicServiceMultiAZObservability"
+      "symbolId": "src/basic_observability/BasicServiceMultiAZObservability:BasicServiceMultiAZObservability"
     },
     "@cdklabs/multi-az-observability.BasicServiceMultiAZObservabilityProps": {
       "assembly": "@cdklabs/multi-az-observability",
       "datatype": true,
       "docs": {
         "stability": "experimental",
-        "summary": "Properties for creating a basic service."
+        "summary": "Properties for creating basic multi-AZ observability."
       },
       "fqn": "@cdklabs/multi-az-observability.BasicServiceMultiAZObservabilityProps",
       "kind": "interface",
       "locationInModule": {
-        "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
+        "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
         "line": 11
       },
       "name": "BasicServiceMultiAZObservabilityProps",
@@ -4722,30 +4722,30 @@
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "Whether to create a dashboard displaying the metrics and alarms."
+            "summary": "The number of datapoints to alarm on for latency and availability alarms."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 86
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 123
           },
-          "name": "createDashboard",
+          "name": "datapointsToAlarm",
           "type": {
-            "primitive": "boolean"
+            "primitive": "number"
           }
         },
         {
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "The number of datapoints to alarm on for latency and availability alarms."
+            "summary": "The number of evaluation periods for latency and availabiltiy alarms."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 139
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 118
           },
-          "name": "datapointsToAlarm",
+          "name": "evaluationPeriods",
           "type": {
             "primitive": "number"
           }
@@ -4753,15 +4753,16 @@
         {
           "abstract": true,
           "docs": {
+            "remarks": "For example\n1% or 5%, specify as 1 or 5.",
             "stability": "experimental",
-            "summary": "The number of evaluation periods for latency and availabiltiy alarms."
+            "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/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 134
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 49
           },
-          "name": "evaluationPeriods",
+          "name": "faultCountPercentageThreshold",
           "type": {
             "primitive": "number"
           }
@@ -4770,32 +4771,32 @@
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "The algorithm to use for performing outlier detection."
+            "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/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 76
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 61
           },
-          "name": "outlierDetectionAlgorithm",
+          "name": "latencyStatistic",
           "type": {
-            "fqn": "@cdklabs/multi-az-observability.OutlierDetectionAlgorithm"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "The period to evaluate metrics."
+            "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/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 81
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 55
           },
-          "name": "period",
+          "name": "latencyThreshold",
           "type": {
-            "fqn": "aws-cdk-lib.Duration"
+            "primitive": "number"
           }
         },
         {
@@ -4806,8 +4807,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 30
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 34
           },
           "name": "serviceName",
           "type": {
@@ -4817,14 +4818,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- No alarms for ALBs will be created",
+            "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.",
             "stability": "experimental",
             "summary": "The application load balancers being used by the service."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 25
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 29
           },
           "name": "applicationLoadBalancers",
           "optional": true,
@@ -4840,15 +4842,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- The assets will be uploaded to the default defined\nasset location.",
+            "default": "\"The assets will be uploaded to the default defined asset location.\"",
             "remarks": "It will override the bucket location CDK provides by\ndefault for bundled assets. The stack containing this contruct needs\nto have a parameter defined that uses this name. The underlying\nstacks in this construct that deploy assets will copy the parent stack's\nvalue for this property.",
             "stability": "experimental",
             "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 109
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 97
           },
           "name": "assetsBucketParameterName",
           "optional": true,
@@ -4859,15 +4861,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- No object prefix will be added to your custom assets location.\nHowever, if you have overridden something like the 'BucketPrefix' property\nin your stack synthesizer with a variable like \"${AssetsBucketPrefix\",\nyou will need to define this property so it doesn't cause a reference error\neven if the prefix value is blank.",
+            "default": "\"No object prefix will be added to your custom assets location. However, if you have overridden something like the 'BucketPrefix' property in your stack synthesizer with a variable like '${AssetsBucketPrefix}', you will need to define this property so it doesn't cause a reference error even if the prefix value is blank.\"",
             "remarks": "It will override the bucket prefix CDK provides by\ndefault for bundled assets. This property only takes effect if you\ndefined the assetsBucketParameterName. The stack containing this contruct needs\nto have a parameter defined that uses this name. The underlying\nstacks in this construct that deploy assets will copy the parent stack's\nvalue for this property.",
             "stability": "experimental",
             "summary": "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."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 129
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 113
           },
           "name": "assetsBucketPrefixParameterName",
           "optional": true,
@@ -4878,33 +4880,32 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- 5 (as in 5%)",
-            "remarks": "For example\n1% or 5%.",
+            "default": "false",
             "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."
+            "summary": "Whether to create a dashboard displaying the metrics and alarms."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 71
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 75
           },
-          "name": "faultCountPercentageThreshold",
+          "name": "createDashboard",
           "optional": true,
           "type": {
-            "primitive": "number"
+            "primitive": "boolean"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "- 1 hour",
+            "default": "Duration.hours(1)",
             "stability": "experimental",
             "summary": "Dashboard interval."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 93
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 82
           },
           "name": "interval",
           "optional": true,
@@ -4915,14 +4916,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- No alarms for NAT Gateways will be created",
+            "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/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 18
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 20
           },
           "name": "natGateways",
           "optional": true,
@@ -4943,17 +4945,16 @@
         {
           "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",
+            "default": "\"0.01 (as in 0.01%)\"",
             "stability": "experimental",
-            "summary": "The outlier threshold for determining if an AZ is an outlier for latency or faults."
+            "summary": "The amount of packet loss in a NAT GW to determine if an AZ is actually impacted, recommendation is 0.01%."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 54
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 42
           },
-          "name": "outlierThreshold",
+          "name": "packetLossImpactPercentageThreshold",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -4962,23 +4963,23 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- 0.01 (as in 0.01%)",
+            "default": "Duration.minutes(1)",
             "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": "The period to evaluate metrics."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/services/props/BasicServiceMultiAZObservabilityProps.ts",
-            "line": 62
+            "filename": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps.ts",
+            "line": 68
           },
-          "name": "packetLossImpactPercentageThreshold",
+          "name": "period",
           "optional": true,
           "type": {
-            "primitive": "number"
+            "fqn": "aws-cdk-lib.Duration"
           }
         }
       ],
-      "symbolId": "src/services/props/BasicServiceMultiAZObservabilityProps:BasicServiceMultiAZObservabilityProps"
+      "symbolId": "src/basic_observability/props/BasicServiceMultiAZObservabilityProps:BasicServiceMultiAZObservabilityProps"
     },
     "@cdklabs/multi-az-observability.CanaryMetricProps": {
       "assembly": "@cdklabs/multi-az-observability",
@@ -10172,6 +10173,6 @@
       "symbolId": "src/services/props/ServiceProps:ServiceProps"
     }
   },
-  "version": "0.0.0-alpha.0",
-  "fingerprint": "2WkipDNZObIzTazZOw0BKX6zbVOUopPBhOgoKHWVhyU="
+  "version": "0.0.1-alpha.0",
+  "fingerprint": "3PntIR4xTC5HPOtEI5qDjEEJFbUl5OouxteKmL35CAI="
 }