@cdklabs/multi-az-observability 0.0.1-alpha.39 → 0.0.1-alpha.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +1830 -604
- package/API.md +4724 -1382
- package/README.md +14 -14
- package/lib/alarmsandrules/AvailabilityAndLatencyAlarmsAndRules.d.ts +11 -9
- package/lib/alarmsandrules/AvailabilityAndLatencyAlarmsAndRules.js +10 -10
- package/lib/alarmsandrules/props/BaseOperationRegionalAlarmsAndRulesProps.d.ts +4 -3
- package/lib/alarmsandrules/props/BaseOperationRegionalAlarmsAndRulesProps.js +1 -1
- package/lib/azmapper/AvailabilityZoneMapper.js +1 -1
- package/lib/basic_observability/BasicServiceMultiAZObservability.js +4 -6
- package/lib/basic_observability/props/ApplicationLoadBalancerDetectionProps.d.ts +2 -1
- package/lib/basic_observability/props/ApplicationLoadBalancerDetectionProps.js +1 -1
- package/lib/canaries/CanaryFunction.js +3 -3
- package/lib/canaries/src/canary.zip +0 -0
- package/lib/dashboards/ContributorInsightsWidget.d.ts +1 -1
- package/lib/dashboards/ContributorInsightsWidget.js +12 -16
- package/lib/dashboards/OperationAvailabilityAndLatencyDashboard.js +8 -8
- package/lib/dashboards/ServiceAvailabilityAndLatencyDashboard.js +4 -4
- package/lib/index.d.ts +54 -29
- package/lib/index.js +32 -19
- package/lib/metrics/ApplicationLoadBalancerMetrics.d.ts +3 -3
- package/lib/metrics/ApplicationLoadBalancerMetrics.js +5 -8
- package/lib/monitoring/src/monitoring-layer.zip +0 -0
- package/lib/outlier-detection/src/outlier-detection.zip +0 -0
- package/lib/outlier-detection/src/scipy-layer.zip +0 -0
- package/lib/services/CanaryMetrics.d.ts +4 -3
- package/lib/services/CanaryMetrics.js +3 -4
- package/lib/services/CanaryTestAvailabilityMetricsOverride.d.ts +21 -0
- package/lib/services/CanaryTestAvailabilityMetricsOverride.js +23 -0
- package/lib/services/CanaryTestLatencyMetricsOverride.d.ts +15 -0
- package/lib/services/CanaryTestLatencyMetricsOverride.js +20 -0
- package/lib/services/CanaryTestMetricsOverride.d.ts +1 -13
- package/lib/services/CanaryTestMetricsOverride.js +2 -4
- package/lib/services/ContributorInsightRuleDetails.js +1 -1
- package/lib/services/ICanaryMetrics.d.ts +4 -3
- package/lib/services/ICanaryMetrics.js +1 -1
- package/lib/services/ICanaryTestAvailabilityMetricsOverride.d.ts +23 -0
- package/lib/services/ICanaryTestAvailabilityMetricsOverride.js +3 -0
- package/lib/services/ICanaryTestLatencyMetricsOverride.d.ts +13 -0
- package/lib/services/ICanaryTestLatencyMetricsOverride.js +3 -0
- package/lib/services/ICanaryTestMetricsOverride.d.ts +0 -12
- package/lib/services/ICanaryTestMetricsOverride.js +1 -1
- package/lib/services/IInstrumentedServiceMultiAZObservability.d.ts +13 -3
- package/lib/services/IInstrumentedServiceMultiAZObservability.js +1 -1
- package/lib/services/IOperation.d.ts +8 -6
- package/lib/services/IOperation.js +1 -1
- package/lib/services/IOperationAvailabilityMetricDetails.d.ts +18 -0
- package/lib/services/IOperationAvailabilityMetricDetails.js +3 -0
- package/lib/services/IOperationLatencyMetricDetails.d.ts +12 -0
- package/lib/services/IOperationLatencyMetricDetails.js +3 -0
- package/lib/services/IOperationMetricDetails.d.ts +0 -12
- package/lib/services/IOperationMetricDetails.js +1 -1
- package/lib/services/IService.d.ts +4 -3
- package/lib/services/IService.js +1 -1
- package/lib/services/IServiceAvailabilityMetricDetails.d.ts +18 -0
- package/lib/services/IServiceAvailabilityMetricDetails.js +3 -0
- package/lib/services/IServiceLatencyMetricDetails.d.ts +12 -0
- package/lib/services/IServiceLatencyMetricDetails.js +3 -0
- package/lib/services/IServiceMetricDetails.d.ts +0 -12
- package/lib/services/IServiceMetricDetails.js +1 -1
- package/lib/services/InstrumentedServiceMultiAZObservability.d.ts +5 -3
- package/lib/services/InstrumentedServiceMultiAZObservability.js +12 -15
- package/lib/services/Operation.d.ts +8 -6
- package/lib/services/Operation.js +2 -2
- package/lib/services/OperationAvailabilityMetricDetails.d.ts +22 -0
- package/lib/services/OperationAvailabilityMetricDetails.js +24 -0
- package/lib/services/OperationLatencyMetricDetails.d.ts +16 -0
- package/lib/services/OperationLatencyMetricDetails.js +21 -0
- package/lib/services/OperationMetricDetails.d.ts +1 -13
- package/lib/services/OperationMetricDetails.js +2 -8
- package/lib/services/Service.d.ts +4 -3
- package/lib/services/Service.js +2 -2
- package/lib/services/ServiceAvailabilityMetricDetails.d.ts +21 -0
- package/lib/services/ServiceAvailabilityMetricDetails.js +20 -0
- package/lib/services/ServiceLatencyMetricDetails.d.ts +15 -0
- package/lib/services/ServiceLatencyMetricDetails.js +19 -0
- package/lib/services/ServiceMetricDetails.d.ts +1 -13
- package/lib/services/ServiceMetricDetails.js +2 -4
- package/lib/services/props/CanaryMetricProps.d.ts +4 -3
- package/lib/services/props/CanaryMetricProps.js +1 -1
- package/lib/services/props/CanaryTestAvailabilityMetricsOverrideProps.d.ts +22 -0
- package/lib/services/props/CanaryTestAvailabilityMetricsOverrideProps.js +3 -0
- package/lib/services/props/CanaryTestLatencyMetricsOverrideProps.d.ts +14 -0
- package/lib/services/props/CanaryTestLatencyMetricsOverrideProps.js +3 -0
- package/lib/services/props/CanaryTestMetricsOverrideProps.d.ts +0 -16
- package/lib/services/props/CanaryTestMetricsOverrideProps.js +1 -1
- package/lib/services/props/MetricDimensions.js +1 -1
- package/lib/services/props/OperationAvailabilityMetricDetailsProps.d.ts +22 -0
- package/lib/services/props/OperationAvailabilityMetricDetailsProps.js +3 -0
- package/lib/services/props/OperationLatencyMetricDetailsProps.d.ts +14 -0
- package/lib/services/props/OperationLatencyMetricDetailsProps.js +3 -0
- package/lib/services/props/OperationMetricDetailsProps.d.ts +0 -16
- package/lib/services/props/OperationMetricDetailsProps.js +1 -1
- package/lib/services/props/OperationProps.d.ts +4 -3
- package/lib/services/props/OperationProps.js +1 -1
- package/lib/services/props/ServiceAvailabilityMetricDetailsProps.d.ts +18 -0
- package/lib/services/props/ServiceAvailabilityMetricDetailsProps.js +3 -0
- package/lib/services/props/ServiceLatencyMetricDetailsProps.d.ts +12 -0
- package/lib/services/props/ServiceLatencyMetricDetailsProps.js +3 -0
- package/lib/services/props/ServiceMetricDetailsProps.d.ts +0 -12
- package/lib/services/props/ServiceMetricDetailsProps.js +1 -1
- package/lib/services/props/ServiceProps.d.ts +4 -3
- package/lib/services/props/ServiceProps.js +1 -1
- package/lib/utilities/MetricsHelper.d.ts +3 -0
- package/lib/utilities/MetricsHelper.js +17 -1
- package/package.json +5 -5
- package/lib/services/IBasicServiceMultiAZObservability.d.ts +0 -45
- package/lib/services/IBasicServiceMultiAZObservability.js +0 -3
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
]
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.184.0",
|
|
12
12
|
"constructs": "^10.0.5"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -38,32 +38,6 @@
|
|
|
38
38
|
}
|
|
39
39
|
}
|
|
40
40
|
},
|
|
41
|
-
"@aws-cdk/asset-kubectl-v20": {
|
|
42
|
-
"targets": {
|
|
43
|
-
"dotnet": {
|
|
44
|
-
"namespace": "Amazon.CDK.Asset.KubectlV20",
|
|
45
|
-
"packageId": "Amazon.CDK.Asset.KubectlV20"
|
|
46
|
-
},
|
|
47
|
-
"go": {
|
|
48
|
-
"moduleName": "github.com/cdklabs/awscdk-asset-kubectl-go",
|
|
49
|
-
"packageName": "kubectlv20"
|
|
50
|
-
},
|
|
51
|
-
"java": {
|
|
52
|
-
"maven": {
|
|
53
|
-
"artifactId": "cdk-asset-kubectl-v20",
|
|
54
|
-
"groupId": "software.amazon.awscdk"
|
|
55
|
-
},
|
|
56
|
-
"package": "software.amazon.awscdk.cdk.asset.kubectl.v20"
|
|
57
|
-
},
|
|
58
|
-
"js": {
|
|
59
|
-
"npm": "@aws-cdk/asset-kubectl-v20"
|
|
60
|
-
},
|
|
61
|
-
"python": {
|
|
62
|
-
"distName": "aws-cdk.asset-kubectl-v20",
|
|
63
|
-
"module": "aws_cdk.asset_kubectl_v20"
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
},
|
|
67
41
|
"@aws-cdk/asset-node-proxy-agent-v6": {
|
|
68
42
|
"targets": {
|
|
69
43
|
"dotnet": {
|
|
@@ -1644,6 +1618,19 @@
|
|
|
1644
1618
|
}
|
|
1645
1619
|
}
|
|
1646
1620
|
},
|
|
1621
|
+
"aws-cdk-lib.aws_gameliftstreams": {
|
|
1622
|
+
"targets": {
|
|
1623
|
+
"dotnet": {
|
|
1624
|
+
"package": "Amazon.CDK.AWS.GameLiftStreams"
|
|
1625
|
+
},
|
|
1626
|
+
"java": {
|
|
1627
|
+
"package": "software.amazon.awscdk.services.gameliftstreams"
|
|
1628
|
+
},
|
|
1629
|
+
"python": {
|
|
1630
|
+
"module": "aws_cdk.aws_gameliftstreams"
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
},
|
|
1647
1634
|
"aws-cdk-lib.aws_globalaccelerator": {
|
|
1648
1635
|
"targets": {
|
|
1649
1636
|
"dotnet": {
|
|
@@ -1852,29 +1839,29 @@
|
|
|
1852
1839
|
}
|
|
1853
1840
|
}
|
|
1854
1841
|
},
|
|
1855
|
-
"aws-cdk-lib.
|
|
1842
|
+
"aws-cdk-lib.aws_invoicing": {
|
|
1856
1843
|
"targets": {
|
|
1857
1844
|
"dotnet": {
|
|
1858
|
-
"
|
|
1845
|
+
"package": "Amazon.CDK.AWS.Invoicing"
|
|
1859
1846
|
},
|
|
1860
1847
|
"java": {
|
|
1861
|
-
"package": "software.amazon.awscdk.services.
|
|
1848
|
+
"package": "software.amazon.awscdk.services.invoicing"
|
|
1862
1849
|
},
|
|
1863
1850
|
"python": {
|
|
1864
|
-
"module": "aws_cdk.
|
|
1851
|
+
"module": "aws_cdk.aws_invoicing"
|
|
1865
1852
|
}
|
|
1866
1853
|
}
|
|
1867
1854
|
},
|
|
1868
|
-
"aws-cdk-lib.
|
|
1855
|
+
"aws-cdk-lib.aws_iot": {
|
|
1869
1856
|
"targets": {
|
|
1870
1857
|
"dotnet": {
|
|
1871
|
-
"namespace": "Amazon.CDK.AWS.
|
|
1858
|
+
"namespace": "Amazon.CDK.AWS.IoT"
|
|
1872
1859
|
},
|
|
1873
1860
|
"java": {
|
|
1874
|
-
"package": "software.amazon.awscdk.services.
|
|
1861
|
+
"package": "software.amazon.awscdk.services.iot"
|
|
1875
1862
|
},
|
|
1876
1863
|
"python": {
|
|
1877
|
-
"module": "aws_cdk.
|
|
1864
|
+
"module": "aws_cdk.aws_iot"
|
|
1878
1865
|
}
|
|
1879
1866
|
}
|
|
1880
1867
|
},
|
|
@@ -2567,6 +2554,32 @@
|
|
|
2567
2554
|
}
|
|
2568
2555
|
}
|
|
2569
2556
|
},
|
|
2557
|
+
"aws-cdk-lib.aws_notifications": {
|
|
2558
|
+
"targets": {
|
|
2559
|
+
"dotnet": {
|
|
2560
|
+
"package": "Amazon.CDK.AWS.Notifications"
|
|
2561
|
+
},
|
|
2562
|
+
"java": {
|
|
2563
|
+
"package": "software.amazon.awscdk.services.notifications"
|
|
2564
|
+
},
|
|
2565
|
+
"python": {
|
|
2566
|
+
"module": "aws_cdk.aws_notifications"
|
|
2567
|
+
}
|
|
2568
|
+
}
|
|
2569
|
+
},
|
|
2570
|
+
"aws-cdk-lib.aws_notificationscontacts": {
|
|
2571
|
+
"targets": {
|
|
2572
|
+
"dotnet": {
|
|
2573
|
+
"package": "Amazon.CDK.AWS.NotificationsContacts"
|
|
2574
|
+
},
|
|
2575
|
+
"java": {
|
|
2576
|
+
"package": "software.amazon.awscdk.services.notificationscontacts"
|
|
2577
|
+
},
|
|
2578
|
+
"python": {
|
|
2579
|
+
"module": "aws_cdk.aws_notificationscontacts"
|
|
2580
|
+
}
|
|
2581
|
+
}
|
|
2582
|
+
},
|
|
2570
2583
|
"aws-cdk-lib.aws_oam": {
|
|
2571
2584
|
"targets": {
|
|
2572
2585
|
"dotnet": {
|
|
@@ -2723,6 +2736,19 @@
|
|
|
2723
2736
|
}
|
|
2724
2737
|
}
|
|
2725
2738
|
},
|
|
2739
|
+
"aws-cdk-lib.aws_pcs": {
|
|
2740
|
+
"targets": {
|
|
2741
|
+
"dotnet": {
|
|
2742
|
+
"package": "Amazon.CDK.AWS.PCS"
|
|
2743
|
+
},
|
|
2744
|
+
"java": {
|
|
2745
|
+
"package": "software.amazon.awscdk.services.pcs"
|
|
2746
|
+
},
|
|
2747
|
+
"python": {
|
|
2748
|
+
"module": "aws_cdk.aws_pcs"
|
|
2749
|
+
}
|
|
2750
|
+
}
|
|
2751
|
+
},
|
|
2726
2752
|
"aws-cdk-lib.aws_personalize": {
|
|
2727
2753
|
"targets": {
|
|
2728
2754
|
"dotnet": {
|
|
@@ -3178,6 +3204,19 @@
|
|
|
3178
3204
|
}
|
|
3179
3205
|
}
|
|
3180
3206
|
},
|
|
3207
|
+
"aws-cdk-lib.aws_s3tables": {
|
|
3208
|
+
"targets": {
|
|
3209
|
+
"dotnet": {
|
|
3210
|
+
"package": "Amazon.CDK.AWS.S3Tables"
|
|
3211
|
+
},
|
|
3212
|
+
"java": {
|
|
3213
|
+
"package": "software.amazon.awscdk.services.s3tables"
|
|
3214
|
+
},
|
|
3215
|
+
"python": {
|
|
3216
|
+
"module": "aws_cdk.aws_s3tables"
|
|
3217
|
+
}
|
|
3218
|
+
}
|
|
3219
|
+
},
|
|
3181
3220
|
"aws-cdk-lib.aws_sagemaker": {
|
|
3182
3221
|
"targets": {
|
|
3183
3222
|
"dotnet": {
|
|
@@ -3764,19 +3803,6 @@
|
|
|
3764
3803
|
}
|
|
3765
3804
|
}
|
|
3766
3805
|
},
|
|
3767
|
-
"aws-cdk-lib.lambda_layer_kubectl": {
|
|
3768
|
-
"targets": {
|
|
3769
|
-
"dotnet": {
|
|
3770
|
-
"namespace": "Amazon.CDK.LambdaLayer.Kubectl"
|
|
3771
|
-
},
|
|
3772
|
-
"java": {
|
|
3773
|
-
"package": "software.amazon.awscdk.lambdalayer.kubectl"
|
|
3774
|
-
},
|
|
3775
|
-
"python": {
|
|
3776
|
-
"module": "aws_cdk.lambda_layer_kubectl"
|
|
3777
|
-
}
|
|
3778
|
-
}
|
|
3779
|
-
},
|
|
3780
3806
|
"aws-cdk-lib.lambda_layer_node_proxy_agent": {
|
|
3781
3807
|
"targets": {
|
|
3782
3808
|
"dotnet": {
|
|
@@ -3887,7 +3913,7 @@
|
|
|
3887
3913
|
"stability": "experimental"
|
|
3888
3914
|
},
|
|
3889
3915
|
"homepage": "https://github.com/cdklabs/cdk-multi-az-observability",
|
|
3890
|
-
"jsiiVersion": "5.5.
|
|
3916
|
+
"jsiiVersion": "5.5.26 (build adcbaf3)",
|
|
3891
3917
|
"keywords": [
|
|
3892
3918
|
"aws-cdk",
|
|
3893
3919
|
"cdk",
|
|
@@ -3908,7 +3934,7 @@
|
|
|
3908
3934
|
},
|
|
3909
3935
|
"name": "@cdklabs/multi-az-observability",
|
|
3910
3936
|
"readme": {
|
|
3911
|
-
"markdown": " \n\n# multi-az-observability\nThis is a CDK construct for multi-AZ observability to help detect single-AZ impairments. This is currently an `alpha` version, but is being used in the AWS [Advanced Multi-AZ Resilience Patterns](https://catalog.workshops.aws/multi-az-gray-failures/en-US) workshop.\n\nThere is a lot of available information to think through and combine to provide signals about single-AZ impact. To simplify the setup and use reasonable defaults, this construct (available in TypeScript, Go, Python, and .NET [Java coming soon]) sets up the necessary observability. To use the CDK construct, you first define your service like this:\n\n```csharp\nvar wildRydesService = new Service(new ServiceProps(){\n ServiceName = \"WildRydes\",\n BaseUrl = \"http://www.example.com\",\n FaultCountThreshold = 25,\n AvailabilityZoneNames = vpc.AvailabilityZones,\n Period = Duration.Seconds(60),\n LoadBalancer = loadBalancer,\n DefaultAvailabilityMetricDetails = new ServiceMetricDetails(new ServiceMetricDetailsProps() {\n AlarmStatistic = \"Sum\",\n DatapointsToAlarm = 3,\n EvaluationPeriods = 5,\n FaultAlarmThreshold = 1,\n FaultMetricNames = new string[] { \"Fault\", \"Error\" },\n GraphedFaultStatistics = new string[] { \"Sum\" },\n GraphedSuccessStatistics = new string[] { \"Sum\" },\n MetricNamespace = metricsNamespace,\n Period = Duration.Seconds(60),\n SuccessAlarmThreshold = 99,\n SuccessMetricNames = new string[] {\"Success\"},\n Unit = Unit.COUNT,\n }),\n DefaultLatencyMetricDetails = new ServiceMetricDetails(new ServiceMetricDetailsProps(){\n AlarmStatistic = \"p99\",\n DatapointsToAlarm = 3,\n EvaluationPeriods = 5,\n FaultAlarmThreshold = 1,\n FaultMetricNames = new string[] { \"FaultLatency\" },\n GraphedFaultStatistics = new string[] { \"p50\" },\n GraphedSuccessStatistics = new string[] { \"p50\", \"p99\", \"tm50\", \"tm99\" },\n MetricNamespace = metricsNamespace,\n Period = Duration.Seconds(60),\n SuccessAlarmThreshold = 100,\n SuccessMetricNames = new string[] {\"SuccessLatency\"},\n Unit = Unit.MILLISECONDS,\n }),\n DefaultContributorInsightRuleDetails = new ContributorInsightRuleDetails(new ContributorInsightRuleDetailsProps() {\n AvailabilityZoneIdJsonPath = azIdJsonPath,\n FaultMetricJsonPath = faultMetricJsonPath,\n InstanceIdJsonPath = instanceIdJsonPath,\n LogGroups = serverLogGroups,\n OperationNameJsonPath = operationNameJsonPath,\n SuccessLatencyMetricJsonPath = successLatencyMetricJsonPath\n }),\n CanaryTestProps = new AddCanaryTestProps() {\n RequestCount = 10,\n LoadBalancer = loadBalancer,\n Schedule = \"rate(1 minute)\",\n NetworkConfiguration = new NetworkConfigurationProps() {\n Vpc = vpc,\n SubnetSelection = new SubnetSelection() { SubnetType = SubnetType.PRIVATE_ISOLATED }\n }\n }\n});\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Signin\",\n Path = \"/signin\",\n Service = wildRydesService,\n Critical = true,\n HttpMethods = new string[] { \"GET\" },\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Signin\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Signin\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Signin\",\n SuccessAlarmThreshold = 150,\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Signin\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = 250\n })\n}));\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Pay\",\n Path = \"/pay\",\n Service = wildRydesService,\n HttpMethods = new string[] { \"GET\" },\n Critical = true,\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Pay\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Pay\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Pay\",\n SuccessAlarmThreshold = 200,\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Pay\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = 300\n })\n}));\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Ride\",\n Path = \"/ride\",\n Service = wildRydesService,\n HttpMethods = new string[] { \"GET\" },\n Critical = true,\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Ride\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Ride\",\n SuccessAlarmThreshold = 350,\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = 550\n })\n}));\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Home\",\n Path = \"/home\",\n Service = wildRydesService,\n HttpMethods = new string[] { \"GET\" },\n Critical = true,\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Home\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Home\",\n SuccessAlarmThreshold = 100,\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = 200\n })\n}));\n```\n\nThen you provide that service definition to the CDK construct.\n\n```csharp\nInstrumentedServiceMultiAZObservability multiAvailabilityZoneObservability = new InstrumentedServiceMultiAZObservability(this, \"MultiAZObservability\", new InstrumentedServiceMultiAZObservabilityProps() {\n Service = wildRydesService,\n CreateDashboards = true,\n Interval = Duration.Minutes(60), // The interval for the dashboard\n OutlierDetectionAlgorithm = OutlierDetectionAlgorithm.STATIC\n});\n```\n\nYou define some characteristics of the service, default values for metrics and alarms, and then add operations as well as any overrides for default values that you need. The construct can also automatically create synthetic canaries that test each operation with a very simple HTTP check, or you can configure your own synthetics and just tell the construct about the metric details and optionally log files. This creates metrics, alarms, and dashboards that can be used to detect single-AZ impact.\n\nIf you don't have service specific logs and custom metrics with per-AZ dimensions, you can still use the construct to evaluate ALB and NAT Gateway metrics to find single AZ faults.\n\n```csharp\nBasicServiceMultiAZObservability multiAZObservability = new BasicServiceMultiAZObservability(this, \"basic-service-\", new BasicServiceMultiAZObservabilityProps() {\n ApplicationLoadBalancerProps = new ApplicationLoadBalancerDetectionProps() {\n ApplicationLoadBalancers = [ myALB ],\n LatencyStatistic = Stats.Percentile(99),\n FaultCountPercentThreshold = 1,\n LatencyThreshold = 500\n },\n NatGatewayProps = new NatGatewayDetectionProps() {\n PacketLossPercentThreshold = 0.01,\n NatGateways = {\n { \"us-east-1a\", [ natGateway1 ] },\n { \"us-east-1b\", [ natGateway2 ] },\n { \"us-east-1c\", [ natGateway3 ] }\n },\n },\n CreateDashboard = true,\n DatapointsToAlarm = 2,\n EvaluationPeriods = 3,\n ServiceName = \"WildRydes\",\n Period = Duration.Seconds(60),\n Interval = Duration.Minutes(60),\n});\n```\n\nIf you provide a load balancer, the construct assumes it is deployed in each AZ of the VPC the load balancer is associated with and will look for HTTP metrics using those AZs as dimensions.\n\nBoth options support running workloads on EC2, ECS, Lambda, and EKS."
|
|
3937
|
+
"markdown": "  \n\n# multi-az-observability\nThis is a CDK construct for multi-AZ observability to help detect single-AZ impairments. This is currently an `alpha` version, but is being used in the AWS [Advanced Multi-AZ Resilience Patterns](https://catalog.workshops.aws/multi-az-gray-failures/en-US) workshop.\n\nThere is a lot of available information to think through and combine to provide signals about single-AZ impact. To simplify the setup and use reasonable defaults, this construct (available in [TypeScript](https://www.npmjs.com/package/@cdklabs/multi-az-observability), [Go](https://github.com/cdklabs/cdk-multi-az-observability-go), [Python](https://pypi.org/project/cdklabs.multi-az-observability/), [.NET](https://www.nuget.org/packages/Cdklabs.MultiAZObservability), and [Java](https://central.sonatype.com/artifact/io.github.cdklabs/cdk-multi-az-observability)) sets up the necessary observability. To use the CDK construct, you first define your service like this:\n\n```csharp\nvar wildRydesService = new Service(new ServiceProps(){\n ServiceName = \"WildRydes\",\n BaseUrl = \"http://www.example.com\",\n FaultCountThreshold = 25,\n AvailabilityZoneNames = vpc.AvailabilityZones,\n Period = Duration.Seconds(60),\n LoadBalancer = loadBalancer,\n DefaultAvailabilityMetricDetails = new ServiceMetricDetails(new ServiceMetricDetailsProps() {\n AlarmStatistic = \"Sum\",\n DatapointsToAlarm = 3,\n EvaluationPeriods = 5,\n FaultAlarmThreshold = 1,\n FaultMetricNames = new string[] { \"Fault\", \"Error\" },\n GraphedFaultStatistics = new string[] { \"Sum\" },\n GraphedSuccessStatistics = new string[] { \"Sum\" },\n MetricNamespace = metricsNamespace,\n Period = Duration.Seconds(60),\n SuccessAlarmThreshold = 99,\n SuccessMetricNames = new string[] {\"Success\"},\n Unit = Unit.COUNT,\n }),\n DefaultLatencyMetricDetails = new ServiceMetricDetails(new ServiceMetricDetailsProps(){\n AlarmStatistic = \"p99\",\n DatapointsToAlarm = 3,\n EvaluationPeriods = 5,\n FaultAlarmThreshold = 1,\n FaultMetricNames = new string[] { \"FaultLatency\" },\n GraphedFaultStatistics = new string[] { \"p50\" },\n GraphedSuccessStatistics = new string[] { \"p50\", \"p99\", \"tm50\", \"tm99\" },\n MetricNamespace = metricsNamespace,\n Period = Duration.Seconds(60),\n SuccessAlarmThreshold = Duration.Millis(100),\n SuccessMetricNames = new string[] {\"SuccessLatency\"},\n Unit = Unit.MILLISECONDS,\n }),\n DefaultContributorInsightRuleDetails = new ContributorInsightRuleDetails(new ContributorInsightRuleDetailsProps() {\n AvailabilityZoneIdJsonPath = azIdJsonPath,\n FaultMetricJsonPath = faultMetricJsonPath,\n InstanceIdJsonPath = instanceIdJsonPath,\n LogGroups = serverLogGroups,\n OperationNameJsonPath = operationNameJsonPath,\n SuccessLatencyMetricJsonPath = successLatencyMetricJsonPath\n }),\n CanaryTestProps = new AddCanaryTestProps() {\n RequestCount = 10,\n LoadBalancer = loadBalancer,\n Schedule = \"rate(1 minute)\",\n NetworkConfiguration = new NetworkConfigurationProps() {\n Vpc = vpc,\n SubnetSelection = new SubnetSelection() { SubnetType = SubnetType.PRIVATE_ISOLATED }\n }\n }\n});\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Signin\",\n Path = \"/signin\",\n Service = wildRydesService,\n Critical = true,\n HttpMethods = new string[] { \"GET\" },\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Signin\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Signin\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Signin\",\n SuccessAlarmThreshold = Duration.Millis(150),\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Signin\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = Duration.Millis(250),\n })\n}));\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Pay\",\n Path = \"/pay\",\n Service = wildRydesService,\n HttpMethods = new string[] { \"GET\" },\n Critical = true,\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Pay\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Pay\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Pay\",\n SuccessAlarmThreshold = Duration.Millis(200),\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Pay\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = Duration.Millis(300)\n })\n}));\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Ride\",\n Path = \"/ride\",\n Service = wildRydesService,\n HttpMethods = new string[] { \"GET\" },\n Critical = true,\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Ride\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Ride\",\n SuccessAlarmThreshold = Duration.Millis(350),\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = Duration.Millis(550)\n })\n}));\nwildRydesService.AddOperation(new Operation(new OperationProps() {\n OperationName = \"Home\",\n Path = \"/home\",\n Service = wildRydesService,\n HttpMethods = new string[] { \"GET\" },\n Critical = true,\n ServerSideAvailabilityMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Home\",\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultAvailabilityMetricDetails),\n ServerSideLatencyMetricDetails = new OperationMetricDetails(new OperationMetricDetailsProps() {\n OperationName = \"Home\",\n SuccessAlarmThreshold = Duration.Millis(100),\n MetricDimensions = new MetricDimensions(new Dictionary<string, string> {{ \"Operation\", \"Ride\"}}, \"AZ-ID\", \"Region\")\n }, wildRydesService.DefaultLatencyMetricDetails),\n CanaryTestLatencyMetricsOverride = new CanaryTestMetricsOverride(new CanaryTestMetricsOverrideProps() {\n SuccessAlarmThreshold = Duration.Millis(200)\n })\n}));\n```\n\nThen you provide that service definition to the CDK construct.\n\n```csharp\nInstrumentedServiceMultiAZObservability multiAvailabilityZoneObservability = new InstrumentedServiceMultiAZObservability(this, \"MultiAZObservability\", new InstrumentedServiceMultiAZObservabilityProps() {\n Service = wildRydesService,\n CreateDashboards = true,\n Interval = Duration.Minutes(60), // The interval for the dashboard\n OutlierDetectionAlgorithm = OutlierDetectionAlgorithm.STATIC\n});\n```\n\nYou define some characteristics of the service, default values for metrics and alarms, and then add operations as well as any overrides for default values that you need. The construct can also automatically create synthetic canaries that test each operation with a very simple HTTP check, or you can configure your own synthetics and just tell the construct about the metric details and optionally log files. This creates metrics, alarms, and dashboards that can be used to detect single-AZ impact. You can access these alarms from the `multiAvailabilityZoneObservability` object and use them in your CDK project to start automation, send SNS notifications, or incorporate in your own dashboards.\n\nIf you don't have service specific logs and custom metrics with per-AZ dimensions, you can still use the construct to evaluate ALB and/or NAT Gateway metrics to find single AZ impairments.\n\n```csharp\nBasicServiceMultiAZObservability multiAZObservability = new BasicServiceMultiAZObservability(this, \"basic-service-\", new BasicServiceMultiAZObservabilityProps() {\n ApplicationLoadBalancerProps = new ApplicationLoadBalancerDetectionProps() {\n ApplicationLoadBalancers = [ myALB ],\n LatencyStatistic = Stats.Percentile(99),\n FaultCountPercentThreshold = 1,\n LatencyThreshold = Duration.Millis(500)\n },\n NatGatewayProps = new NatGatewayDetectionProps() {\n PacketLossPercentThreshold = 0.01,\n NatGateways = {\n { \"us-east-1a\", [ natGateway1 ] },\n { \"us-east-1b\", [ natGateway2 ] },\n { \"us-east-1c\", [ natGateway3 ] }\n },\n },\n CreateDashboard = true,\n DatapointsToAlarm = 2,\n EvaluationPeriods = 3,\n ServiceName = \"WildRydes\",\n Period = Duration.Seconds(60),\n Interval = Duration.Minutes(60),\n});\n```\n\nIf you provide a load balancer, the construct assumes it is deployed in each AZ of the VPC the load balancer is associated with and will look for HTTP metrics using those AZs as dimensions.\n\nBoth options support running workloads on EC2, ECS, Lambda, and EKS."
|
|
3912
3938
|
},
|
|
3913
3939
|
"repository": {
|
|
3914
3940
|
"type": "git",
|
|
@@ -4177,7 +4203,7 @@
|
|
|
4177
4203
|
"kind": "interface",
|
|
4178
4204
|
"locationInModule": {
|
|
4179
4205
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4180
|
-
"line":
|
|
4206
|
+
"line": 9
|
|
4181
4207
|
},
|
|
4182
4208
|
"name": "ApplicationLoadBalancerDetectionProps",
|
|
4183
4209
|
"properties": [
|
|
@@ -4190,7 +4216,7 @@
|
|
|
4190
4216
|
"immutable": true,
|
|
4191
4217
|
"locationInModule": {
|
|
4192
4218
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4193
|
-
"line":
|
|
4219
|
+
"line": 14
|
|
4194
4220
|
},
|
|
4195
4221
|
"name": "applicationLoadBalancers",
|
|
4196
4222
|
"type": {
|
|
@@ -4212,7 +4238,7 @@
|
|
|
4212
4238
|
"immutable": true,
|
|
4213
4239
|
"locationInModule": {
|
|
4214
4240
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4215
|
-
"line":
|
|
4241
|
+
"line": 21
|
|
4216
4242
|
},
|
|
4217
4243
|
"name": "faultCountPercentThreshold",
|
|
4218
4244
|
"type": {
|
|
@@ -4228,7 +4254,7 @@
|
|
|
4228
4254
|
"immutable": true,
|
|
4229
4255
|
"locationInModule": {
|
|
4230
4256
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4231
|
-
"line":
|
|
4257
|
+
"line": 33
|
|
4232
4258
|
},
|
|
4233
4259
|
"name": "latencyStatistic",
|
|
4234
4260
|
"type": {
|
|
@@ -4244,11 +4270,11 @@
|
|
|
4244
4270
|
"immutable": true,
|
|
4245
4271
|
"locationInModule": {
|
|
4246
4272
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4247
|
-
"line":
|
|
4273
|
+
"line": 27
|
|
4248
4274
|
},
|
|
4249
4275
|
"name": "latencyThreshold",
|
|
4250
4276
|
"type": {
|
|
4251
|
-
"
|
|
4277
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
4252
4278
|
}
|
|
4253
4279
|
},
|
|
4254
4280
|
{
|
|
@@ -4261,7 +4287,7 @@
|
|
|
4261
4287
|
"immutable": true,
|
|
4262
4288
|
"locationInModule": {
|
|
4263
4289
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4264
|
-
"line":
|
|
4290
|
+
"line": 45
|
|
4265
4291
|
},
|
|
4266
4292
|
"name": "availabilityOutlierAlgorithm",
|
|
4267
4293
|
"optional": true,
|
|
@@ -4279,7 +4305,7 @@
|
|
|
4279
4305
|
"immutable": true,
|
|
4280
4306
|
"locationInModule": {
|
|
4281
4307
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4282
|
-
"line":
|
|
4308
|
+
"line": 52
|
|
4283
4309
|
},
|
|
4284
4310
|
"name": "availabilityOutlierThreshold",
|
|
4285
4311
|
"optional": true,
|
|
@@ -4297,7 +4323,7 @@
|
|
|
4297
4323
|
"immutable": true,
|
|
4298
4324
|
"locationInModule": {
|
|
4299
4325
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4300
|
-
"line":
|
|
4326
|
+
"line": 39
|
|
4301
4327
|
},
|
|
4302
4328
|
"name": "latencyOutlierAlgorithm",
|
|
4303
4329
|
"optional": true,
|
|
@@ -4315,7 +4341,7 @@
|
|
|
4315
4341
|
"immutable": true,
|
|
4316
4342
|
"locationInModule": {
|
|
4317
4343
|
"filename": "src/basic_observability/props/ApplicationLoadBalancerDetectionProps.ts",
|
|
4318
|
-
"line":
|
|
4344
|
+
"line": 59
|
|
4319
4345
|
},
|
|
4320
4346
|
"name": "latencyOutlierThreshold",
|
|
4321
4347
|
"optional": true,
|
|
@@ -4853,6 +4879,7 @@
|
|
|
4853
4879
|
},
|
|
4854
4880
|
"name": "dashboard",
|
|
4855
4881
|
"optional": true,
|
|
4882
|
+
"overrides": "@cdklabs/multi-az-observability.IBasicServiceMultiAZObservability",
|
|
4856
4883
|
"type": {
|
|
4857
4884
|
"fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard"
|
|
4858
4885
|
}
|
|
@@ -5114,7 +5141,7 @@
|
|
|
5114
5141
|
"kind": "interface",
|
|
5115
5142
|
"locationInModule": {
|
|
5116
5143
|
"filename": "src/services/props/CanaryMetricProps.ts",
|
|
5117
|
-
"line":
|
|
5144
|
+
"line": 9
|
|
5118
5145
|
},
|
|
5119
5146
|
"name": "CanaryMetricProps",
|
|
5120
5147
|
"properties": [
|
|
@@ -5127,11 +5154,11 @@
|
|
|
5127
5154
|
"immutable": true,
|
|
5128
5155
|
"locationInModule": {
|
|
5129
5156
|
"filename": "src/services/props/CanaryMetricProps.ts",
|
|
5130
|
-
"line":
|
|
5157
|
+
"line": 13
|
|
5131
5158
|
},
|
|
5132
5159
|
"name": "canaryAvailabilityMetricDetails",
|
|
5133
5160
|
"type": {
|
|
5134
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5161
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
5135
5162
|
}
|
|
5136
5163
|
},
|
|
5137
5164
|
{
|
|
@@ -5143,11 +5170,11 @@
|
|
|
5143
5170
|
"immutable": true,
|
|
5144
5171
|
"locationInModule": {
|
|
5145
5172
|
"filename": "src/services/props/CanaryMetricProps.ts",
|
|
5146
|
-
"line":
|
|
5173
|
+
"line": 18
|
|
5147
5174
|
},
|
|
5148
5175
|
"name": "canaryLatencyMetricDetails",
|
|
5149
5176
|
"type": {
|
|
5150
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5177
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
5151
5178
|
}
|
|
5152
5179
|
}
|
|
5153
5180
|
],
|
|
@@ -5166,7 +5193,7 @@
|
|
|
5166
5193
|
},
|
|
5167
5194
|
"locationInModule": {
|
|
5168
5195
|
"filename": "src/services/CanaryMetrics.ts",
|
|
5169
|
-
"line":
|
|
5196
|
+
"line": 22
|
|
5170
5197
|
},
|
|
5171
5198
|
"parameters": [
|
|
5172
5199
|
{
|
|
@@ -5183,7 +5210,7 @@
|
|
|
5183
5210
|
"kind": "class",
|
|
5184
5211
|
"locationInModule": {
|
|
5185
5212
|
"filename": "src/services/CanaryMetrics.ts",
|
|
5186
|
-
"line":
|
|
5213
|
+
"line": 11
|
|
5187
5214
|
},
|
|
5188
5215
|
"name": "CanaryMetrics",
|
|
5189
5216
|
"properties": [
|
|
@@ -5195,12 +5222,12 @@
|
|
|
5195
5222
|
"immutable": true,
|
|
5196
5223
|
"locationInModule": {
|
|
5197
5224
|
"filename": "src/services/CanaryMetrics.ts",
|
|
5198
|
-
"line":
|
|
5225
|
+
"line": 15
|
|
5199
5226
|
},
|
|
5200
5227
|
"name": "canaryAvailabilityMetricDetails",
|
|
5201
5228
|
"overrides": "@cdklabs/multi-az-observability.ICanaryMetrics",
|
|
5202
5229
|
"type": {
|
|
5203
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5230
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
5204
5231
|
}
|
|
5205
5232
|
},
|
|
5206
5233
|
{
|
|
@@ -5211,81 +5238,61 @@
|
|
|
5211
5238
|
"immutable": true,
|
|
5212
5239
|
"locationInModule": {
|
|
5213
5240
|
"filename": "src/services/CanaryMetrics.ts",
|
|
5214
|
-
"line":
|
|
5241
|
+
"line": 20
|
|
5215
5242
|
},
|
|
5216
5243
|
"name": "canaryLatencyMetricDetails",
|
|
5217
5244
|
"overrides": "@cdklabs/multi-az-observability.ICanaryMetrics",
|
|
5218
5245
|
"type": {
|
|
5219
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5246
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
5220
5247
|
}
|
|
5221
5248
|
}
|
|
5222
5249
|
],
|
|
5223
5250
|
"symbolId": "src/services/CanaryMetrics:CanaryMetrics"
|
|
5224
5251
|
},
|
|
5225
|
-
"@cdklabs/multi-az-observability.
|
|
5252
|
+
"@cdklabs/multi-az-observability.CanaryTestAvailabilityMetricsOverride": {
|
|
5226
5253
|
"assembly": "@cdklabs/multi-az-observability",
|
|
5254
|
+
"base": "@cdklabs/multi-az-observability.CanaryTestMetricsOverride",
|
|
5227
5255
|
"docs": {
|
|
5228
5256
|
"stability": "experimental",
|
|
5229
5257
|
"summary": "Provides overrides for the default metric settings used for the automatically created canary tests."
|
|
5230
5258
|
},
|
|
5231
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5259
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestAvailabilityMetricsOverride",
|
|
5232
5260
|
"initializer": {
|
|
5233
5261
|
"docs": {
|
|
5234
5262
|
"stability": "experimental"
|
|
5235
5263
|
},
|
|
5236
5264
|
"locationInModule": {
|
|
5237
|
-
"filename": "src/services/
|
|
5238
|
-
"line":
|
|
5265
|
+
"filename": "src/services/CanaryTestAvailabilityMetricsOverride.ts",
|
|
5266
|
+
"line": 25
|
|
5239
5267
|
},
|
|
5240
5268
|
"parameters": [
|
|
5241
5269
|
{
|
|
5242
5270
|
"name": "props",
|
|
5243
5271
|
"type": {
|
|
5244
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5272
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestAvailabilityMetricsOverrideProps"
|
|
5245
5273
|
}
|
|
5246
5274
|
}
|
|
5247
5275
|
]
|
|
5248
5276
|
},
|
|
5249
|
-
"interfaces": [
|
|
5250
|
-
"@cdklabs/multi-az-observability.ICanaryTestMetricsOverride"
|
|
5251
|
-
],
|
|
5252
5277
|
"kind": "class",
|
|
5253
5278
|
"locationInModule": {
|
|
5254
|
-
"filename": "src/services/
|
|
5255
|
-
"line":
|
|
5279
|
+
"filename": "src/services/CanaryTestAvailabilityMetricsOverride.ts",
|
|
5280
|
+
"line": 10
|
|
5256
5281
|
},
|
|
5257
|
-
"name": "
|
|
5282
|
+
"name": "CanaryTestAvailabilityMetricsOverride",
|
|
5258
5283
|
"properties": [
|
|
5259
5284
|
{
|
|
5260
5285
|
"docs": {
|
|
5261
5286
|
"stability": "experimental",
|
|
5262
|
-
"summary": "The
|
|
5263
|
-
},
|
|
5264
|
-
"immutable": true,
|
|
5265
|
-
"locationInModule": {
|
|
5266
|
-
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5267
|
-
"line": 16
|
|
5268
|
-
},
|
|
5269
|
-
"name": "alarmStatistic",
|
|
5270
|
-
"optional": true,
|
|
5271
|
-
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5272
|
-
"type": {
|
|
5273
|
-
"primitive": "string"
|
|
5274
|
-
}
|
|
5275
|
-
},
|
|
5276
|
-
{
|
|
5277
|
-
"docs": {
|
|
5278
|
-
"stability": "experimental",
|
|
5279
|
-
"summary": "The number of datapoints to alarm on for latency and availability alarms."
|
|
5287
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
5280
5288
|
},
|
|
5281
5289
|
"immutable": true,
|
|
5282
5290
|
"locationInModule": {
|
|
5283
|
-
"filename": "src/services/
|
|
5284
|
-
"line":
|
|
5291
|
+
"filename": "src/services/CanaryTestAvailabilityMetricsOverride.ts",
|
|
5292
|
+
"line": 23
|
|
5285
5293
|
},
|
|
5286
|
-
"name": "
|
|
5294
|
+
"name": "faultAlarmThreshold",
|
|
5287
5295
|
"optional": true,
|
|
5288
|
-
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5289
5296
|
"type": {
|
|
5290
5297
|
"primitive": "number"
|
|
5291
5298
|
}
|
|
@@ -5293,156 +5300,321 @@
|
|
|
5293
5300
|
{
|
|
5294
5301
|
"docs": {
|
|
5295
5302
|
"stability": "experimental",
|
|
5296
|
-
"summary": "The
|
|
5303
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
5297
5304
|
},
|
|
5298
5305
|
"immutable": true,
|
|
5299
5306
|
"locationInModule": {
|
|
5300
|
-
"filename": "src/services/
|
|
5301
|
-
"line":
|
|
5307
|
+
"filename": "src/services/CanaryTestAvailabilityMetricsOverride.ts",
|
|
5308
|
+
"line": 16
|
|
5302
5309
|
},
|
|
5303
|
-
"name": "
|
|
5310
|
+
"name": "successAlarmThreshold",
|
|
5304
5311
|
"optional": true,
|
|
5305
|
-
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5306
5312
|
"type": {
|
|
5307
5313
|
"primitive": "number"
|
|
5308
5314
|
}
|
|
5309
|
-
}
|
|
5315
|
+
}
|
|
5316
|
+
],
|
|
5317
|
+
"symbolId": "src/services/CanaryTestAvailabilityMetricsOverride:CanaryTestAvailabilityMetricsOverride"
|
|
5318
|
+
},
|
|
5319
|
+
"@cdklabs/multi-az-observability.CanaryTestAvailabilityMetricsOverrideProps": {
|
|
5320
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
5321
|
+
"datatype": true,
|
|
5322
|
+
"docs": {
|
|
5323
|
+
"stability": "experimental",
|
|
5324
|
+
"summary": "Properties for canary metrics in an operation."
|
|
5325
|
+
},
|
|
5326
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestAvailabilityMetricsOverrideProps",
|
|
5327
|
+
"interfaces": [
|
|
5328
|
+
"@cdklabs/multi-az-observability.CanaryTestMetricsOverrideProps"
|
|
5329
|
+
],
|
|
5330
|
+
"kind": "interface",
|
|
5331
|
+
"locationInModule": {
|
|
5332
|
+
"filename": "src/services/props/CanaryTestAvailabilityMetricsOverrideProps.ts",
|
|
5333
|
+
"line": 8
|
|
5334
|
+
},
|
|
5335
|
+
"name": "CanaryTestAvailabilityMetricsOverrideProps",
|
|
5336
|
+
"properties": [
|
|
5310
5337
|
{
|
|
5338
|
+
"abstract": true,
|
|
5311
5339
|
"docs": {
|
|
5340
|
+
"default": "- This property will use the default defined for the service",
|
|
5312
5341
|
"stability": "experimental",
|
|
5313
5342
|
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
5314
5343
|
},
|
|
5315
5344
|
"immutable": true,
|
|
5316
5345
|
"locationInModule": {
|
|
5317
|
-
"filename": "src/services/
|
|
5318
|
-
"line":
|
|
5346
|
+
"filename": "src/services/props/CanaryTestAvailabilityMetricsOverrideProps.ts",
|
|
5347
|
+
"line": 25
|
|
5319
5348
|
},
|
|
5320
5349
|
"name": "faultAlarmThreshold",
|
|
5321
5350
|
"optional": true,
|
|
5322
|
-
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5323
5351
|
"type": {
|
|
5324
5352
|
"primitive": "number"
|
|
5325
5353
|
}
|
|
5326
5354
|
},
|
|
5327
5355
|
{
|
|
5356
|
+
"abstract": true,
|
|
5328
5357
|
"docs": {
|
|
5358
|
+
"default": "- This property will use the default defined for the service",
|
|
5329
5359
|
"stability": "experimental",
|
|
5330
|
-
"summary": "The
|
|
5360
|
+
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
5331
5361
|
},
|
|
5332
5362
|
"immutable": true,
|
|
5333
5363
|
"locationInModule": {
|
|
5334
|
-
"filename": "src/services/
|
|
5335
|
-
"line":
|
|
5364
|
+
"filename": "src/services/props/CanaryTestAvailabilityMetricsOverrideProps.ts",
|
|
5365
|
+
"line": 16
|
|
5336
5366
|
},
|
|
5337
|
-
"name": "
|
|
5367
|
+
"name": "successAlarmThreshold",
|
|
5338
5368
|
"optional": true,
|
|
5339
|
-
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5340
5369
|
"type": {
|
|
5341
|
-
"
|
|
5370
|
+
"primitive": "number"
|
|
5342
5371
|
}
|
|
5372
|
+
}
|
|
5373
|
+
],
|
|
5374
|
+
"symbolId": "src/services/props/CanaryTestAvailabilityMetricsOverrideProps:CanaryTestAvailabilityMetricsOverrideProps"
|
|
5375
|
+
},
|
|
5376
|
+
"@cdklabs/multi-az-observability.CanaryTestLatencyMetricsOverride": {
|
|
5377
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
5378
|
+
"base": "@cdklabs/multi-az-observability.CanaryTestMetricsOverride",
|
|
5379
|
+
"docs": {
|
|
5380
|
+
"stability": "experimental",
|
|
5381
|
+
"summary": "Provides overrides for the default metric settings used for the automatically created canary tests."
|
|
5382
|
+
},
|
|
5383
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestLatencyMetricsOverride",
|
|
5384
|
+
"initializer": {
|
|
5385
|
+
"docs": {
|
|
5386
|
+
"stability": "experimental"
|
|
5387
|
+
},
|
|
5388
|
+
"locationInModule": {
|
|
5389
|
+
"filename": "src/services/CanaryTestLatencyMetricsOverride.ts",
|
|
5390
|
+
"line": 18
|
|
5343
5391
|
},
|
|
5392
|
+
"parameters": [
|
|
5393
|
+
{
|
|
5394
|
+
"name": "props",
|
|
5395
|
+
"type": {
|
|
5396
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestLatencyMetricsOverrideProps"
|
|
5397
|
+
}
|
|
5398
|
+
}
|
|
5399
|
+
]
|
|
5400
|
+
},
|
|
5401
|
+
"kind": "class",
|
|
5402
|
+
"locationInModule": {
|
|
5403
|
+
"filename": "src/services/CanaryTestLatencyMetricsOverride.ts",
|
|
5404
|
+
"line": 11
|
|
5405
|
+
},
|
|
5406
|
+
"name": "CanaryTestLatencyMetricsOverride",
|
|
5407
|
+
"properties": [
|
|
5344
5408
|
{
|
|
5345
5409
|
"docs": {
|
|
5346
5410
|
"stability": "experimental",
|
|
5347
|
-
"summary": "The threshold for alarms associated with success metrics, for example if
|
|
5411
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
5348
5412
|
},
|
|
5349
5413
|
"immutable": true,
|
|
5350
5414
|
"locationInModule": {
|
|
5351
|
-
"filename": "src/services/
|
|
5352
|
-
"line":
|
|
5415
|
+
"filename": "src/services/CanaryTestLatencyMetricsOverride.ts",
|
|
5416
|
+
"line": 16
|
|
5353
5417
|
},
|
|
5354
5418
|
"name": "successAlarmThreshold",
|
|
5355
5419
|
"optional": true,
|
|
5356
|
-
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5357
5420
|
"type": {
|
|
5358
|
-
"
|
|
5421
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
5359
5422
|
}
|
|
5360
5423
|
}
|
|
5361
5424
|
],
|
|
5362
|
-
"symbolId": "src/services/
|
|
5425
|
+
"symbolId": "src/services/CanaryTestLatencyMetricsOverride:CanaryTestLatencyMetricsOverride"
|
|
5363
5426
|
},
|
|
5364
|
-
"@cdklabs/multi-az-observability.
|
|
5427
|
+
"@cdklabs/multi-az-observability.CanaryTestLatencyMetricsOverrideProps": {
|
|
5365
5428
|
"assembly": "@cdklabs/multi-az-observability",
|
|
5366
5429
|
"datatype": true,
|
|
5367
5430
|
"docs": {
|
|
5368
5431
|
"stability": "experimental",
|
|
5369
|
-
"summary": "
|
|
5432
|
+
"summary": "Properties for canary metrics in an operation."
|
|
5370
5433
|
},
|
|
5371
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
5434
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestLatencyMetricsOverrideProps",
|
|
5435
|
+
"interfaces": [
|
|
5436
|
+
"@cdklabs/multi-az-observability.CanaryTestMetricsOverrideProps"
|
|
5437
|
+
],
|
|
5372
5438
|
"kind": "interface",
|
|
5373
5439
|
"locationInModule": {
|
|
5374
|
-
"filename": "src/services/props/
|
|
5375
|
-
"line":
|
|
5440
|
+
"filename": "src/services/props/CanaryTestLatencyMetricsOverrideProps.ts",
|
|
5441
|
+
"line": 9
|
|
5376
5442
|
},
|
|
5377
|
-
"name": "
|
|
5443
|
+
"name": "CanaryTestLatencyMetricsOverrideProps",
|
|
5378
5444
|
"properties": [
|
|
5379
5445
|
{
|
|
5380
5446
|
"abstract": true,
|
|
5381
5447
|
"docs": {
|
|
5382
5448
|
"default": "- This property will use the default defined for the service",
|
|
5383
5449
|
"stability": "experimental",
|
|
5384
|
-
"summary": "The
|
|
5450
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
5385
5451
|
},
|
|
5386
5452
|
"immutable": true,
|
|
5387
5453
|
"locationInModule": {
|
|
5388
|
-
"filename": "src/services/props/
|
|
5389
|
-
"line":
|
|
5454
|
+
"filename": "src/services/props/CanaryTestLatencyMetricsOverrideProps.ts",
|
|
5455
|
+
"line": 16
|
|
5390
5456
|
},
|
|
5391
|
-
"name": "
|
|
5457
|
+
"name": "successAlarmThreshold",
|
|
5392
5458
|
"optional": true,
|
|
5393
5459
|
"type": {
|
|
5394
|
-
"
|
|
5460
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
5395
5461
|
}
|
|
5462
|
+
}
|
|
5463
|
+
],
|
|
5464
|
+
"symbolId": "src/services/props/CanaryTestLatencyMetricsOverrideProps:CanaryTestLatencyMetricsOverrideProps"
|
|
5465
|
+
},
|
|
5466
|
+
"@cdklabs/multi-az-observability.CanaryTestMetricsOverride": {
|
|
5467
|
+
"abstract": true,
|
|
5468
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
5469
|
+
"docs": {
|
|
5470
|
+
"stability": "experimental",
|
|
5471
|
+
"summary": "Provides overrides for the default metric settings used for the automatically created canary tests."
|
|
5472
|
+
},
|
|
5473
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestMetricsOverride",
|
|
5474
|
+
"initializer": {
|
|
5475
|
+
"docs": {
|
|
5476
|
+
"stability": "experimental"
|
|
5396
5477
|
},
|
|
5397
|
-
{
|
|
5398
|
-
"
|
|
5399
|
-
"
|
|
5400
|
-
|
|
5478
|
+
"locationInModule": {
|
|
5479
|
+
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5480
|
+
"line": 33
|
|
5481
|
+
},
|
|
5482
|
+
"parameters": [
|
|
5483
|
+
{
|
|
5484
|
+
"name": "props",
|
|
5485
|
+
"type": {
|
|
5486
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestMetricsOverrideProps"
|
|
5487
|
+
}
|
|
5488
|
+
}
|
|
5489
|
+
]
|
|
5490
|
+
},
|
|
5491
|
+
"interfaces": [
|
|
5492
|
+
"@cdklabs/multi-az-observability.ICanaryTestMetricsOverride"
|
|
5493
|
+
],
|
|
5494
|
+
"kind": "class",
|
|
5495
|
+
"locationInModule": {
|
|
5496
|
+
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5497
|
+
"line": 11
|
|
5498
|
+
},
|
|
5499
|
+
"name": "CanaryTestMetricsOverride",
|
|
5500
|
+
"properties": [
|
|
5501
|
+
{
|
|
5502
|
+
"docs": {
|
|
5503
|
+
"stability": "experimental",
|
|
5504
|
+
"summary": "The statistic used for alarms, for availability metrics this should be \"Sum\", for latency metrics it could something like \"p99\" or \"p99.9\"."
|
|
5505
|
+
},
|
|
5506
|
+
"immutable": true,
|
|
5507
|
+
"locationInModule": {
|
|
5508
|
+
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5509
|
+
"line": 16
|
|
5510
|
+
},
|
|
5511
|
+
"name": "alarmStatistic",
|
|
5512
|
+
"optional": true,
|
|
5513
|
+
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5514
|
+
"type": {
|
|
5515
|
+
"primitive": "string"
|
|
5516
|
+
}
|
|
5517
|
+
},
|
|
5518
|
+
{
|
|
5519
|
+
"docs": {
|
|
5401
5520
|
"stability": "experimental",
|
|
5402
5521
|
"summary": "The number of datapoints to alarm on for latency and availability alarms."
|
|
5403
5522
|
},
|
|
5404
5523
|
"immutable": true,
|
|
5405
5524
|
"locationInModule": {
|
|
5406
|
-
"filename": "src/services/
|
|
5407
|
-
"line":
|
|
5525
|
+
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5526
|
+
"line": 31
|
|
5408
5527
|
},
|
|
5409
5528
|
"name": "datapointsToAlarm",
|
|
5410
5529
|
"optional": true,
|
|
5530
|
+
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5411
5531
|
"type": {
|
|
5412
5532
|
"primitive": "number"
|
|
5413
5533
|
}
|
|
5414
5534
|
},
|
|
5415
5535
|
{
|
|
5416
|
-
"abstract": true,
|
|
5417
5536
|
"docs": {
|
|
5418
|
-
"default": "- This property will use the default defined for the service",
|
|
5419
5537
|
"stability": "experimental",
|
|
5420
5538
|
"summary": "The number of evaluation periods for latency and availabiltiy alarms."
|
|
5421
5539
|
},
|
|
5422
5540
|
"immutable": true,
|
|
5423
5541
|
"locationInModule": {
|
|
5424
|
-
"filename": "src/services/
|
|
5425
|
-
"line":
|
|
5542
|
+
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5543
|
+
"line": 26
|
|
5426
5544
|
},
|
|
5427
5545
|
"name": "evaluationPeriods",
|
|
5428
5546
|
"optional": true,
|
|
5547
|
+
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5429
5548
|
"type": {
|
|
5430
5549
|
"primitive": "number"
|
|
5431
5550
|
}
|
|
5432
5551
|
},
|
|
5552
|
+
{
|
|
5553
|
+
"docs": {
|
|
5554
|
+
"stability": "experimental",
|
|
5555
|
+
"summary": "The period for the metrics."
|
|
5556
|
+
},
|
|
5557
|
+
"immutable": true,
|
|
5558
|
+
"locationInModule": {
|
|
5559
|
+
"filename": "src/services/CanaryTestMetricsOverride.ts",
|
|
5560
|
+
"line": 21
|
|
5561
|
+
},
|
|
5562
|
+
"name": "period",
|
|
5563
|
+
"optional": true,
|
|
5564
|
+
"overrides": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
5565
|
+
"type": {
|
|
5566
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
5567
|
+
}
|
|
5568
|
+
}
|
|
5569
|
+
],
|
|
5570
|
+
"symbolId": "src/services/CanaryTestMetricsOverride:CanaryTestMetricsOverride"
|
|
5571
|
+
},
|
|
5572
|
+
"@cdklabs/multi-az-observability.CanaryTestMetricsOverrideProps": {
|
|
5573
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
5574
|
+
"datatype": true,
|
|
5575
|
+
"docs": {
|
|
5576
|
+
"stability": "experimental",
|
|
5577
|
+
"summary": "The properties for creating an override."
|
|
5578
|
+
},
|
|
5579
|
+
"fqn": "@cdklabs/multi-az-observability.CanaryTestMetricsOverrideProps",
|
|
5580
|
+
"kind": "interface",
|
|
5581
|
+
"locationInModule": {
|
|
5582
|
+
"filename": "src/services/props/CanaryTestMetricsOverrideProps.ts",
|
|
5583
|
+
"line": 8
|
|
5584
|
+
},
|
|
5585
|
+
"name": "CanaryTestMetricsOverrideProps",
|
|
5586
|
+
"properties": [
|
|
5587
|
+
{
|
|
5588
|
+
"abstract": true,
|
|
5589
|
+
"docs": {
|
|
5590
|
+
"default": "- This property will use the default defined for the service",
|
|
5591
|
+
"stability": "experimental",
|
|
5592
|
+
"summary": "The statistic used for alarms, for availability metrics this should be \"Sum\", for latency metrics it could something like \"p99\" or \"p99.9\"."
|
|
5593
|
+
},
|
|
5594
|
+
"immutable": true,
|
|
5595
|
+
"locationInModule": {
|
|
5596
|
+
"filename": "src/services/props/CanaryTestMetricsOverrideProps.ts",
|
|
5597
|
+
"line": 15
|
|
5598
|
+
},
|
|
5599
|
+
"name": "alarmStatistic",
|
|
5600
|
+
"optional": true,
|
|
5601
|
+
"type": {
|
|
5602
|
+
"primitive": "string"
|
|
5603
|
+
}
|
|
5604
|
+
},
|
|
5433
5605
|
{
|
|
5434
5606
|
"abstract": true,
|
|
5435
5607
|
"docs": {
|
|
5436
5608
|
"default": "- This property will use the default defined for the service",
|
|
5437
5609
|
"stability": "experimental",
|
|
5438
|
-
"summary": "The
|
|
5610
|
+
"summary": "The number of datapoints to alarm on for latency and availability alarms."
|
|
5439
5611
|
},
|
|
5440
5612
|
"immutable": true,
|
|
5441
5613
|
"locationInModule": {
|
|
5442
5614
|
"filename": "src/services/props/CanaryTestMetricsOverrideProps.ts",
|
|
5443
|
-
"line":
|
|
5615
|
+
"line": 36
|
|
5444
5616
|
},
|
|
5445
|
-
"name": "
|
|
5617
|
+
"name": "datapointsToAlarm",
|
|
5446
5618
|
"optional": true,
|
|
5447
5619
|
"type": {
|
|
5448
5620
|
"primitive": "number"
|
|
@@ -5453,17 +5625,17 @@
|
|
|
5453
5625
|
"docs": {
|
|
5454
5626
|
"default": "- This property will use the default defined for the service",
|
|
5455
5627
|
"stability": "experimental",
|
|
5456
|
-
"summary": "The
|
|
5628
|
+
"summary": "The number of evaluation periods for latency and availabiltiy alarms."
|
|
5457
5629
|
},
|
|
5458
5630
|
"immutable": true,
|
|
5459
5631
|
"locationInModule": {
|
|
5460
5632
|
"filename": "src/services/props/CanaryTestMetricsOverrideProps.ts",
|
|
5461
|
-
"line":
|
|
5633
|
+
"line": 29
|
|
5462
5634
|
},
|
|
5463
|
-
"name": "
|
|
5635
|
+
"name": "evaluationPeriods",
|
|
5464
5636
|
"optional": true,
|
|
5465
5637
|
"type": {
|
|
5466
|
-
"
|
|
5638
|
+
"primitive": "number"
|
|
5467
5639
|
}
|
|
5468
5640
|
},
|
|
5469
5641
|
{
|
|
@@ -5471,17 +5643,17 @@
|
|
|
5471
5643
|
"docs": {
|
|
5472
5644
|
"default": "- This property will use the default defined for the service",
|
|
5473
5645
|
"stability": "experimental",
|
|
5474
|
-
"summary": "The
|
|
5646
|
+
"summary": "The period for the metrics."
|
|
5475
5647
|
},
|
|
5476
5648
|
"immutable": true,
|
|
5477
5649
|
"locationInModule": {
|
|
5478
5650
|
"filename": "src/services/props/CanaryTestMetricsOverrideProps.ts",
|
|
5479
|
-
"line":
|
|
5651
|
+
"line": 22
|
|
5480
5652
|
},
|
|
5481
|
-
"name": "
|
|
5653
|
+
"name": "period",
|
|
5482
5654
|
"optional": true,
|
|
5483
5655
|
"type": {
|
|
5484
|
-
"
|
|
5656
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
5485
5657
|
}
|
|
5486
5658
|
}
|
|
5487
5659
|
],
|
|
@@ -6035,6 +6207,145 @@
|
|
|
6035
6207
|
],
|
|
6036
6208
|
"symbolId": "src/azmapper/IAvailabilityZoneMapper:IAvailabilityZoneMapper"
|
|
6037
6209
|
},
|
|
6210
|
+
"@cdklabs/multi-az-observability.IBaseOperationRegionalAlarmsAndRules": {
|
|
6211
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
6212
|
+
"docs": {
|
|
6213
|
+
"stability": "experimental",
|
|
6214
|
+
"summary": "Base regional alarms and rules."
|
|
6215
|
+
},
|
|
6216
|
+
"fqn": "@cdklabs/multi-az-observability.IBaseOperationRegionalAlarmsAndRules",
|
|
6217
|
+
"kind": "interface",
|
|
6218
|
+
"locationInModule": {
|
|
6219
|
+
"filename": "src/alarmsandrules/IBaseOperationRegionalAlarmsAndRules.ts",
|
|
6220
|
+
"line": 8
|
|
6221
|
+
},
|
|
6222
|
+
"name": "IBaseOperationRegionalAlarmsAndRules",
|
|
6223
|
+
"properties": [
|
|
6224
|
+
{
|
|
6225
|
+
"abstract": true,
|
|
6226
|
+
"docs": {
|
|
6227
|
+
"stability": "experimental",
|
|
6228
|
+
"summary": "Availability alarm for this operation."
|
|
6229
|
+
},
|
|
6230
|
+
"locationInModule": {
|
|
6231
|
+
"filename": "src/alarmsandrules/IBaseOperationRegionalAlarmsAndRules.ts",
|
|
6232
|
+
"line": 12
|
|
6233
|
+
},
|
|
6234
|
+
"name": "availabilityAlarm",
|
|
6235
|
+
"type": {
|
|
6236
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6237
|
+
}
|
|
6238
|
+
},
|
|
6239
|
+
{
|
|
6240
|
+
"abstract": true,
|
|
6241
|
+
"docs": {
|
|
6242
|
+
"stability": "experimental",
|
|
6243
|
+
"summary": "Composite alarm for either availabiltiy or latency impact to this operation."
|
|
6244
|
+
},
|
|
6245
|
+
"locationInModule": {
|
|
6246
|
+
"filename": "src/alarmsandrules/IBaseOperationRegionalAlarmsAndRules.ts",
|
|
6247
|
+
"line": 22
|
|
6248
|
+
},
|
|
6249
|
+
"name": "availabilityOrLatencyAlarm",
|
|
6250
|
+
"type": {
|
|
6251
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6252
|
+
}
|
|
6253
|
+
},
|
|
6254
|
+
{
|
|
6255
|
+
"abstract": true,
|
|
6256
|
+
"docs": {
|
|
6257
|
+
"stability": "experimental",
|
|
6258
|
+
"summary": "Latency alarm for this operation."
|
|
6259
|
+
},
|
|
6260
|
+
"locationInModule": {
|
|
6261
|
+
"filename": "src/alarmsandrules/IBaseOperationRegionalAlarmsAndRules.ts",
|
|
6262
|
+
"line": 17
|
|
6263
|
+
},
|
|
6264
|
+
"name": "latencyAlarm",
|
|
6265
|
+
"type": {
|
|
6266
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6267
|
+
}
|
|
6268
|
+
}
|
|
6269
|
+
],
|
|
6270
|
+
"symbolId": "src/alarmsandrules/IBaseOperationRegionalAlarmsAndRules:IBaseOperationRegionalAlarmsAndRules"
|
|
6271
|
+
},
|
|
6272
|
+
"@cdklabs/multi-az-observability.IBaseOperationZonalAlarmsAndRules": {
|
|
6273
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
6274
|
+
"docs": {
|
|
6275
|
+
"stability": "experimental",
|
|
6276
|
+
"summary": "The base operation zonal alarms and rules."
|
|
6277
|
+
},
|
|
6278
|
+
"fqn": "@cdklabs/multi-az-observability.IBaseOperationZonalAlarmsAndRules",
|
|
6279
|
+
"kind": "interface",
|
|
6280
|
+
"locationInModule": {
|
|
6281
|
+
"filename": "src/alarmsandrules/IBaseOperationZonalAlarmsAndRules.ts",
|
|
6282
|
+
"line": 8
|
|
6283
|
+
},
|
|
6284
|
+
"name": "IBaseOperationZonalAlarmsAndRules",
|
|
6285
|
+
"properties": [
|
|
6286
|
+
{
|
|
6287
|
+
"abstract": true,
|
|
6288
|
+
"docs": {
|
|
6289
|
+
"stability": "experimental",
|
|
6290
|
+
"summary": "Availability alarm for this operation."
|
|
6291
|
+
},
|
|
6292
|
+
"locationInModule": {
|
|
6293
|
+
"filename": "src/alarmsandrules/IBaseOperationZonalAlarmsAndRules.ts",
|
|
6294
|
+
"line": 12
|
|
6295
|
+
},
|
|
6296
|
+
"name": "availabilityAlarm",
|
|
6297
|
+
"type": {
|
|
6298
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6299
|
+
}
|
|
6300
|
+
},
|
|
6301
|
+
{
|
|
6302
|
+
"abstract": true,
|
|
6303
|
+
"docs": {
|
|
6304
|
+
"stability": "experimental",
|
|
6305
|
+
"summary": "Alarm that indicates that this AZ is an outlier for fault rate."
|
|
6306
|
+
},
|
|
6307
|
+
"locationInModule": {
|
|
6308
|
+
"filename": "src/alarmsandrules/IBaseOperationZonalAlarmsAndRules.ts",
|
|
6309
|
+
"line": 22
|
|
6310
|
+
},
|
|
6311
|
+
"name": "availabilityZoneIsOutlierForFaults",
|
|
6312
|
+
"type": {
|
|
6313
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6314
|
+
}
|
|
6315
|
+
},
|
|
6316
|
+
{
|
|
6317
|
+
"abstract": true,
|
|
6318
|
+
"docs": {
|
|
6319
|
+
"stability": "experimental",
|
|
6320
|
+
"summary": "Alarm that indicates this AZ is an outlier for high latency."
|
|
6321
|
+
},
|
|
6322
|
+
"locationInModule": {
|
|
6323
|
+
"filename": "src/alarmsandrules/IBaseOperationZonalAlarmsAndRules.ts",
|
|
6324
|
+
"line": 27
|
|
6325
|
+
},
|
|
6326
|
+
"name": "availabilityZoneIsOutlierForLatency",
|
|
6327
|
+
"type": {
|
|
6328
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6329
|
+
}
|
|
6330
|
+
},
|
|
6331
|
+
{
|
|
6332
|
+
"abstract": true,
|
|
6333
|
+
"docs": {
|
|
6334
|
+
"stability": "experimental",
|
|
6335
|
+
"summary": "Latency alarm for this operation."
|
|
6336
|
+
},
|
|
6337
|
+
"locationInModule": {
|
|
6338
|
+
"filename": "src/alarmsandrules/IBaseOperationZonalAlarmsAndRules.ts",
|
|
6339
|
+
"line": 17
|
|
6340
|
+
},
|
|
6341
|
+
"name": "latencyAlarm",
|
|
6342
|
+
"type": {
|
|
6343
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6344
|
+
}
|
|
6345
|
+
}
|
|
6346
|
+
],
|
|
6347
|
+
"symbolId": "src/alarmsandrules/IBaseOperationZonalAlarmsAndRules:IBaseOperationZonalAlarmsAndRules"
|
|
6348
|
+
},
|
|
6038
6349
|
"@cdklabs/multi-az-observability.IBasicServiceMultiAZObservability": {
|
|
6039
6350
|
"assembly": "@cdklabs/multi-az-observability",
|
|
6040
6351
|
"docs": {
|
|
@@ -6047,8 +6358,8 @@
|
|
|
6047
6358
|
],
|
|
6048
6359
|
"kind": "interface",
|
|
6049
6360
|
"locationInModule": {
|
|
6050
|
-
"filename": "src/
|
|
6051
|
-
"line":
|
|
6361
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6362
|
+
"line": 12
|
|
6052
6363
|
},
|
|
6053
6364
|
"name": "IBasicServiceMultiAZObservability",
|
|
6054
6365
|
"properties": [
|
|
@@ -6059,8 +6370,8 @@
|
|
|
6059
6370
|
"summary": "The alarms indicating if an AZ has isolated impact from either ALB or NAT GW metrics."
|
|
6060
6371
|
},
|
|
6061
6372
|
"locationInModule": {
|
|
6062
|
-
"filename": "src/
|
|
6063
|
-
"line":
|
|
6373
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6374
|
+
"line": 47
|
|
6064
6375
|
},
|
|
6065
6376
|
"name": "aggregateZonalIsolatedImpactAlarms",
|
|
6066
6377
|
"type": {
|
|
@@ -6079,8 +6390,8 @@
|
|
|
6079
6390
|
"summary": "The name of the service."
|
|
6080
6391
|
},
|
|
6081
6392
|
"locationInModule": {
|
|
6082
|
-
"filename": "src/
|
|
6083
|
-
"line":
|
|
6393
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6394
|
+
"line": 27
|
|
6084
6395
|
},
|
|
6085
6396
|
"name": "serviceName",
|
|
6086
6397
|
"type": {
|
|
@@ -6090,12 +6401,13 @@
|
|
|
6090
6401
|
{
|
|
6091
6402
|
"abstract": true,
|
|
6092
6403
|
"docs": {
|
|
6404
|
+
"remarks": "This will be 1 composite alarm \nper AZ that triggers if any ALB in that AZ sees outlier impact.",
|
|
6093
6405
|
"stability": "experimental",
|
|
6094
6406
|
"summary": "The alarms indicating if an AZ is an outlier for ALB faults and has isolated impact."
|
|
6095
6407
|
},
|
|
6096
6408
|
"locationInModule": {
|
|
6097
|
-
"filename": "src/
|
|
6098
|
-
"line":
|
|
6409
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6410
|
+
"line": 41
|
|
6099
6411
|
},
|
|
6100
6412
|
"name": "albZonalIsolatedImpactAlarms",
|
|
6101
6413
|
"optional": true,
|
|
@@ -6115,8 +6427,8 @@
|
|
|
6115
6427
|
"summary": "The application load balancers being used by the service."
|
|
6116
6428
|
},
|
|
6117
6429
|
"locationInModule": {
|
|
6118
|
-
"filename": "src/
|
|
6119
|
-
"line":
|
|
6430
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6431
|
+
"line": 22
|
|
6120
6432
|
},
|
|
6121
6433
|
"name": "applicationLoadBalancers",
|
|
6122
6434
|
"optional": true,
|
|
@@ -6133,21 +6445,37 @@
|
|
|
6133
6445
|
"abstract": true,
|
|
6134
6446
|
"docs": {
|
|
6135
6447
|
"stability": "experimental",
|
|
6136
|
-
"summary": "The
|
|
6448
|
+
"summary": "The optional dashboard created for observability."
|
|
6137
6449
|
},
|
|
6138
6450
|
"locationInModule": {
|
|
6139
|
-
"filename": "src/
|
|
6140
|
-
"line":
|
|
6451
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6452
|
+
"line": 52
|
|
6141
6453
|
},
|
|
6142
|
-
"name": "
|
|
6454
|
+
"name": "dashboard",
|
|
6143
6455
|
"optional": true,
|
|
6144
6456
|
"type": {
|
|
6145
|
-
"
|
|
6146
|
-
|
|
6147
|
-
|
|
6148
|
-
|
|
6149
|
-
|
|
6150
|
-
|
|
6457
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Dashboard"
|
|
6458
|
+
}
|
|
6459
|
+
},
|
|
6460
|
+
{
|
|
6461
|
+
"abstract": true,
|
|
6462
|
+
"docs": {
|
|
6463
|
+
"stability": "experimental",
|
|
6464
|
+
"summary": "The NAT Gateways being used in the service, each set of NAT Gateways are keyed by their Availability Zone Id."
|
|
6465
|
+
},
|
|
6466
|
+
"locationInModule": {
|
|
6467
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6468
|
+
"line": 17
|
|
6469
|
+
},
|
|
6470
|
+
"name": "natGateways",
|
|
6471
|
+
"optional": true,
|
|
6472
|
+
"type": {
|
|
6473
|
+
"collection": {
|
|
6474
|
+
"elementtype": {
|
|
6475
|
+
"collection": {
|
|
6476
|
+
"elementtype": {
|
|
6477
|
+
"fqn": "aws-cdk-lib.aws_ec2.CfnNatGateway"
|
|
6478
|
+
},
|
|
6151
6479
|
"kind": "array"
|
|
6152
6480
|
}
|
|
6153
6481
|
},
|
|
@@ -6158,12 +6486,13 @@
|
|
|
6158
6486
|
{
|
|
6159
6487
|
"abstract": true,
|
|
6160
6488
|
"docs": {
|
|
6489
|
+
"remarks": "This will be 1 composite alarm \nper AZ that triggers if any NAT GW in that AZ sees outlier impact.",
|
|
6161
6490
|
"stability": "experimental",
|
|
6162
6491
|
"summary": "The alarms indicating if an AZ is an outlier for NAT GW packet loss and has isolated impact."
|
|
6163
6492
|
},
|
|
6164
6493
|
"locationInModule": {
|
|
6165
|
-
"filename": "src/
|
|
6166
|
-
"line":
|
|
6494
|
+
"filename": "src/basic_observability/IBasicServiceMultiAZObservability.ts",
|
|
6495
|
+
"line": 34
|
|
6167
6496
|
},
|
|
6168
6497
|
"name": "natGWZonalIsolatedImpactAlarms",
|
|
6169
6498
|
"optional": true,
|
|
@@ -6177,7 +6506,7 @@
|
|
|
6177
6506
|
}
|
|
6178
6507
|
}
|
|
6179
6508
|
],
|
|
6180
|
-
"symbolId": "src/
|
|
6509
|
+
"symbolId": "src/basic_observability/IBasicServiceMultiAZObservability:IBasicServiceMultiAZObservability"
|
|
6181
6510
|
},
|
|
6182
6511
|
"@cdklabs/multi-az-observability.ICanaryMetrics": {
|
|
6183
6512
|
"assembly": "@cdklabs/multi-az-observability",
|
|
@@ -6189,7 +6518,7 @@
|
|
|
6189
6518
|
"kind": "interface",
|
|
6190
6519
|
"locationInModule": {
|
|
6191
6520
|
"filename": "src/services/ICanaryMetrics.ts",
|
|
6192
|
-
"line":
|
|
6521
|
+
"line": 9
|
|
6193
6522
|
},
|
|
6194
6523
|
"name": "ICanaryMetrics",
|
|
6195
6524
|
"properties": [
|
|
@@ -6202,11 +6531,11 @@
|
|
|
6202
6531
|
"immutable": true,
|
|
6203
6532
|
"locationInModule": {
|
|
6204
6533
|
"filename": "src/services/ICanaryMetrics.ts",
|
|
6205
|
-
"line":
|
|
6534
|
+
"line": 13
|
|
6206
6535
|
},
|
|
6207
6536
|
"name": "canaryAvailabilityMetricDetails",
|
|
6208
6537
|
"type": {
|
|
6209
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
6538
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
6210
6539
|
}
|
|
6211
6540
|
},
|
|
6212
6541
|
{
|
|
@@ -6218,93 +6547,205 @@
|
|
|
6218
6547
|
"immutable": true,
|
|
6219
6548
|
"locationInModule": {
|
|
6220
6549
|
"filename": "src/services/ICanaryMetrics.ts",
|
|
6221
|
-
"line":
|
|
6550
|
+
"line": 18
|
|
6222
6551
|
},
|
|
6223
6552
|
"name": "canaryLatencyMetricDetails",
|
|
6224
6553
|
"type": {
|
|
6225
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
6554
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
6226
6555
|
}
|
|
6227
6556
|
}
|
|
6228
6557
|
],
|
|
6229
6558
|
"symbolId": "src/services/ICanaryMetrics:ICanaryMetrics"
|
|
6230
6559
|
},
|
|
6231
|
-
"@cdklabs/multi-az-observability.
|
|
6560
|
+
"@cdklabs/multi-az-observability.ICanaryOperationRegionalAlarmsAndRules": {
|
|
6561
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
6562
|
+
"docs": {
|
|
6563
|
+
"stability": "experimental",
|
|
6564
|
+
"summary": "The canary operation regional alarms and rules."
|
|
6565
|
+
},
|
|
6566
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryOperationRegionalAlarmsAndRules",
|
|
6567
|
+
"interfaces": [
|
|
6568
|
+
"@cdklabs/multi-az-observability.IBaseOperationRegionalAlarmsAndRules"
|
|
6569
|
+
],
|
|
6570
|
+
"kind": "interface",
|
|
6571
|
+
"locationInModule": {
|
|
6572
|
+
"filename": "src/alarmsandrules/ICanaryOperationRegionalAlarmsAndRules.ts",
|
|
6573
|
+
"line": 8
|
|
6574
|
+
},
|
|
6575
|
+
"name": "ICanaryOperationRegionalAlarmsAndRules",
|
|
6576
|
+
"symbolId": "src/alarmsandrules/ICanaryOperationRegionalAlarmsAndRules:ICanaryOperationRegionalAlarmsAndRules"
|
|
6577
|
+
},
|
|
6578
|
+
"@cdklabs/multi-az-observability.ICanaryOperationZonalAlarmsAndRules": {
|
|
6579
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
6580
|
+
"docs": {
|
|
6581
|
+
"stability": "experimental",
|
|
6582
|
+
"summary": "Alarms and rules for canary metrics."
|
|
6583
|
+
},
|
|
6584
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryOperationZonalAlarmsAndRules",
|
|
6585
|
+
"interfaces": [
|
|
6586
|
+
"@cdklabs/multi-az-observability.IBaseOperationZonalAlarmsAndRules"
|
|
6587
|
+
],
|
|
6588
|
+
"kind": "interface",
|
|
6589
|
+
"locationInModule": {
|
|
6590
|
+
"filename": "src/alarmsandrules/ICanaryOperationZonalAlarmsAndRules.ts",
|
|
6591
|
+
"line": 9
|
|
6592
|
+
},
|
|
6593
|
+
"name": "ICanaryOperationZonalAlarmsAndRules",
|
|
6594
|
+
"properties": [
|
|
6595
|
+
{
|
|
6596
|
+
"abstract": true,
|
|
6597
|
+
"docs": {
|
|
6598
|
+
"stability": "experimental",
|
|
6599
|
+
"summary": "Alarm that triggers if either latency or availability breach the specified threshold in this AZ and the AZ is an outlier for faults or latency."
|
|
6600
|
+
},
|
|
6601
|
+
"locationInModule": {
|
|
6602
|
+
"filename": "src/alarmsandrules/ICanaryOperationZonalAlarmsAndRules.ts",
|
|
6603
|
+
"line": 15
|
|
6604
|
+
},
|
|
6605
|
+
"name": "isolatedImpactAlarm",
|
|
6606
|
+
"type": {
|
|
6607
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
6608
|
+
}
|
|
6609
|
+
}
|
|
6610
|
+
],
|
|
6611
|
+
"symbolId": "src/alarmsandrules/ICanaryOperationZonalAlarmsAndRules:ICanaryOperationZonalAlarmsAndRules"
|
|
6612
|
+
},
|
|
6613
|
+
"@cdklabs/multi-az-observability.ICanaryTestAvailabilityMetricsOverride": {
|
|
6232
6614
|
"assembly": "@cdklabs/multi-az-observability",
|
|
6233
6615
|
"docs": {
|
|
6234
6616
|
"stability": "experimental",
|
|
6235
6617
|
"summary": "Provides overrides for the default metric settings used for the automatically created canary tests."
|
|
6236
6618
|
},
|
|
6237
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
6619
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestAvailabilityMetricsOverride",
|
|
6620
|
+
"interfaces": [
|
|
6621
|
+
"@cdklabs/multi-az-observability.ICanaryTestMetricsOverride"
|
|
6622
|
+
],
|
|
6238
6623
|
"kind": "interface",
|
|
6239
6624
|
"locationInModule": {
|
|
6240
|
-
"filename": "src/services/
|
|
6625
|
+
"filename": "src/services/ICanaryTestAvailabilityMetricsOverride.ts",
|
|
6241
6626
|
"line": 9
|
|
6242
6627
|
},
|
|
6243
|
-
"name": "
|
|
6628
|
+
"name": "ICanaryTestAvailabilityMetricsOverride",
|
|
6244
6629
|
"properties": [
|
|
6245
6630
|
{
|
|
6246
6631
|
"abstract": true,
|
|
6247
6632
|
"docs": {
|
|
6633
|
+
"default": "- This property will use the default defined for the service",
|
|
6248
6634
|
"stability": "experimental",
|
|
6249
|
-
"summary": "The
|
|
6635
|
+
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
6250
6636
|
},
|
|
6251
6637
|
"immutable": true,
|
|
6252
6638
|
"locationInModule": {
|
|
6253
|
-
"filename": "src/services/
|
|
6254
|
-
"line":
|
|
6639
|
+
"filename": "src/services/ICanaryTestAvailabilityMetricsOverride.ts",
|
|
6640
|
+
"line": 26
|
|
6255
6641
|
},
|
|
6256
|
-
"name": "
|
|
6642
|
+
"name": "faultAlarmThreshold",
|
|
6257
6643
|
"optional": true,
|
|
6258
6644
|
"type": {
|
|
6259
|
-
"primitive": "
|
|
6645
|
+
"primitive": "number"
|
|
6260
6646
|
}
|
|
6261
6647
|
},
|
|
6262
6648
|
{
|
|
6263
6649
|
"abstract": true,
|
|
6264
6650
|
"docs": {
|
|
6651
|
+
"default": "- This property will use the default defined for the service",
|
|
6265
6652
|
"stability": "experimental",
|
|
6266
|
-
"summary": "The
|
|
6653
|
+
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
6267
6654
|
},
|
|
6268
6655
|
"immutable": true,
|
|
6269
6656
|
"locationInModule": {
|
|
6270
|
-
"filename": "src/services/
|
|
6271
|
-
"line":
|
|
6657
|
+
"filename": "src/services/ICanaryTestAvailabilityMetricsOverride.ts",
|
|
6658
|
+
"line": 17
|
|
6272
6659
|
},
|
|
6273
|
-
"name": "
|
|
6660
|
+
"name": "successAlarmThreshold",
|
|
6274
6661
|
"optional": true,
|
|
6275
6662
|
"type": {
|
|
6276
6663
|
"primitive": "number"
|
|
6277
6664
|
}
|
|
6278
|
-
}
|
|
6665
|
+
}
|
|
6666
|
+
],
|
|
6667
|
+
"symbolId": "src/services/ICanaryTestAvailabilityMetricsOverride:ICanaryTestAvailabilityMetricsOverride"
|
|
6668
|
+
},
|
|
6669
|
+
"@cdklabs/multi-az-observability.ICanaryTestLatencyMetricsOverride": {
|
|
6670
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
6671
|
+
"docs": {
|
|
6672
|
+
"stability": "experimental",
|
|
6673
|
+
"summary": "Provides overrides for the default metric settings used for the automatically created canary tests."
|
|
6674
|
+
},
|
|
6675
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestLatencyMetricsOverride",
|
|
6676
|
+
"interfaces": [
|
|
6677
|
+
"@cdklabs/multi-az-observability.ICanaryTestMetricsOverride"
|
|
6678
|
+
],
|
|
6679
|
+
"kind": "interface",
|
|
6680
|
+
"locationInModule": {
|
|
6681
|
+
"filename": "src/services/ICanaryTestLatencyMetricsOverride.ts",
|
|
6682
|
+
"line": 10
|
|
6683
|
+
},
|
|
6684
|
+
"name": "ICanaryTestLatencyMetricsOverride",
|
|
6685
|
+
"properties": [
|
|
6279
6686
|
{
|
|
6280
6687
|
"abstract": true,
|
|
6281
6688
|
"docs": {
|
|
6282
6689
|
"stability": "experimental",
|
|
6283
|
-
"summary": "The
|
|
6690
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
6691
|
+
},
|
|
6692
|
+
"immutable": true,
|
|
6693
|
+
"locationInModule": {
|
|
6694
|
+
"filename": "src/services/ICanaryTestLatencyMetricsOverride.ts",
|
|
6695
|
+
"line": 15
|
|
6696
|
+
},
|
|
6697
|
+
"name": "successAlarmThreshold",
|
|
6698
|
+
"optional": true,
|
|
6699
|
+
"type": {
|
|
6700
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
6701
|
+
}
|
|
6702
|
+
}
|
|
6703
|
+
],
|
|
6704
|
+
"symbolId": "src/services/ICanaryTestLatencyMetricsOverride:ICanaryTestLatencyMetricsOverride"
|
|
6705
|
+
},
|
|
6706
|
+
"@cdklabs/multi-az-observability.ICanaryTestMetricsOverride": {
|
|
6707
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
6708
|
+
"docs": {
|
|
6709
|
+
"stability": "experimental",
|
|
6710
|
+
"summary": "Provides overrides for the default metric settings used for the automatically created canary tests."
|
|
6711
|
+
},
|
|
6712
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestMetricsOverride",
|
|
6713
|
+
"kind": "interface",
|
|
6714
|
+
"locationInModule": {
|
|
6715
|
+
"filename": "src/services/ICanaryTestMetricsOverride.ts",
|
|
6716
|
+
"line": 9
|
|
6717
|
+
},
|
|
6718
|
+
"name": "ICanaryTestMetricsOverride",
|
|
6719
|
+
"properties": [
|
|
6720
|
+
{
|
|
6721
|
+
"abstract": true,
|
|
6722
|
+
"docs": {
|
|
6723
|
+
"stability": "experimental",
|
|
6724
|
+
"summary": "The statistic used for alarms, for availability metrics this should be \"Sum\", for latency metrics it could something like \"p99\" or \"p99.9\"."
|
|
6284
6725
|
},
|
|
6285
6726
|
"immutable": true,
|
|
6286
6727
|
"locationInModule": {
|
|
6287
6728
|
"filename": "src/services/ICanaryTestMetricsOverride.ts",
|
|
6288
|
-
"line":
|
|
6729
|
+
"line": 14
|
|
6289
6730
|
},
|
|
6290
|
-
"name": "
|
|
6731
|
+
"name": "alarmStatistic",
|
|
6291
6732
|
"optional": true,
|
|
6292
6733
|
"type": {
|
|
6293
|
-
"primitive": "
|
|
6734
|
+
"primitive": "string"
|
|
6294
6735
|
}
|
|
6295
6736
|
},
|
|
6296
6737
|
{
|
|
6297
6738
|
"abstract": true,
|
|
6298
6739
|
"docs": {
|
|
6299
6740
|
"stability": "experimental",
|
|
6300
|
-
"summary": "The
|
|
6741
|
+
"summary": "The number of datapoints to alarm on for latency and availability alarms."
|
|
6301
6742
|
},
|
|
6302
6743
|
"immutable": true,
|
|
6303
6744
|
"locationInModule": {
|
|
6304
6745
|
"filename": "src/services/ICanaryTestMetricsOverride.ts",
|
|
6305
|
-
"line":
|
|
6746
|
+
"line": 29
|
|
6306
6747
|
},
|
|
6307
|
-
"name": "
|
|
6748
|
+
"name": "datapointsToAlarm",
|
|
6308
6749
|
"optional": true,
|
|
6309
6750
|
"type": {
|
|
6310
6751
|
"primitive": "number"
|
|
@@ -6314,34 +6755,34 @@
|
|
|
6314
6755
|
"abstract": true,
|
|
6315
6756
|
"docs": {
|
|
6316
6757
|
"stability": "experimental",
|
|
6317
|
-
"summary": "The
|
|
6758
|
+
"summary": "The number of evaluation periods for latency and availabiltiy alarms."
|
|
6318
6759
|
},
|
|
6319
6760
|
"immutable": true,
|
|
6320
6761
|
"locationInModule": {
|
|
6321
6762
|
"filename": "src/services/ICanaryTestMetricsOverride.ts",
|
|
6322
|
-
"line":
|
|
6763
|
+
"line": 24
|
|
6323
6764
|
},
|
|
6324
|
-
"name": "
|
|
6765
|
+
"name": "evaluationPeriods",
|
|
6325
6766
|
"optional": true,
|
|
6326
6767
|
"type": {
|
|
6327
|
-
"
|
|
6768
|
+
"primitive": "number"
|
|
6328
6769
|
}
|
|
6329
6770
|
},
|
|
6330
6771
|
{
|
|
6331
6772
|
"abstract": true,
|
|
6332
6773
|
"docs": {
|
|
6333
6774
|
"stability": "experimental",
|
|
6334
|
-
"summary": "The
|
|
6775
|
+
"summary": "The period for the metrics."
|
|
6335
6776
|
},
|
|
6336
6777
|
"immutable": true,
|
|
6337
6778
|
"locationInModule": {
|
|
6338
6779
|
"filename": "src/services/ICanaryTestMetricsOverride.ts",
|
|
6339
|
-
"line":
|
|
6780
|
+
"line": 19
|
|
6340
6781
|
},
|
|
6341
|
-
"name": "
|
|
6782
|
+
"name": "period",
|
|
6342
6783
|
"optional": true,
|
|
6343
6784
|
"type": {
|
|
6344
|
-
"
|
|
6785
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
6345
6786
|
}
|
|
6346
6787
|
}
|
|
6347
6788
|
],
|
|
@@ -6480,21 +6921,43 @@
|
|
|
6480
6921
|
"kind": "interface",
|
|
6481
6922
|
"locationInModule": {
|
|
6482
6923
|
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6483
|
-
"line":
|
|
6924
|
+
"line": 12
|
|
6484
6925
|
},
|
|
6485
6926
|
"name": "IInstrumentedServiceMultiAZObservability",
|
|
6486
6927
|
"properties": [
|
|
6487
6928
|
{
|
|
6488
6929
|
"abstract": true,
|
|
6489
6930
|
"docs": {
|
|
6490
|
-
"remarks": "
|
|
6931
|
+
"remarks": "You can get the \ngranular alarms that compose the higher level aggregate alarms\nfor each operation.",
|
|
6491
6932
|
"stability": "experimental",
|
|
6492
|
-
"summary": "
|
|
6933
|
+
"summary": "Key represents the operation name and the value is the set of zonal alarms and rules for that operation."
|
|
6493
6934
|
},
|
|
6494
6935
|
"immutable": true,
|
|
6495
6936
|
"locationInModule": {
|
|
6496
6937
|
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6497
|
-
"line":
|
|
6938
|
+
"line": 34
|
|
6939
|
+
},
|
|
6940
|
+
"name": "perOperationAlarmsAndRules",
|
|
6941
|
+
"type": {
|
|
6942
|
+
"collection": {
|
|
6943
|
+
"elementtype": {
|
|
6944
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAlarmsAndRules"
|
|
6945
|
+
},
|
|
6946
|
+
"kind": "map"
|
|
6947
|
+
}
|
|
6948
|
+
}
|
|
6949
|
+
},
|
|
6950
|
+
{
|
|
6951
|
+
"abstract": true,
|
|
6952
|
+
"docs": {
|
|
6953
|
+
"remarks": "This is a shortcut to\naccess the same alarms from the perOperationAlarmsAndRules property.",
|
|
6954
|
+
"stability": "experimental",
|
|
6955
|
+
"summary": "Index into the dictionary by operation name, then by Availability Zone Name to get the alarms that indicate an AZ shows isolated impact from availability or latency as seen by either the server-side or canary."
|
|
6956
|
+
},
|
|
6957
|
+
"immutable": true,
|
|
6958
|
+
"locationInModule": {
|
|
6959
|
+
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6960
|
+
"line": 24
|
|
6498
6961
|
},
|
|
6499
6962
|
"name": "perOperationZonalImpactAlarms",
|
|
6500
6963
|
"type": {
|
|
@@ -6520,7 +6983,7 @@
|
|
|
6520
6983
|
"immutable": true,
|
|
6521
6984
|
"locationInModule": {
|
|
6522
6985
|
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6523
|
-
"line":
|
|
6986
|
+
"line": 16
|
|
6524
6987
|
},
|
|
6525
6988
|
"name": "serviceAlarms",
|
|
6526
6989
|
"type": {
|
|
@@ -6537,7 +7000,7 @@
|
|
|
6537
7000
|
"immutable": true,
|
|
6538
7001
|
"locationInModule": {
|
|
6539
7002
|
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6540
|
-
"line":
|
|
7003
|
+
"line": 54
|
|
6541
7004
|
},
|
|
6542
7005
|
"name": "canaryLogGroup",
|
|
6543
7006
|
"optional": true,
|
|
@@ -6554,7 +7017,7 @@
|
|
|
6554
7017
|
"immutable": true,
|
|
6555
7018
|
"locationInModule": {
|
|
6556
7019
|
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6557
|
-
"line":
|
|
7020
|
+
"line": 41
|
|
6558
7021
|
},
|
|
6559
7022
|
"name": "operationDashboards",
|
|
6560
7023
|
"optional": true,
|
|
@@ -6576,7 +7039,7 @@
|
|
|
6576
7039
|
"immutable": true,
|
|
6577
7040
|
"locationInModule": {
|
|
6578
7041
|
"filename": "src/services/IInstrumentedServiceMultiAZObservability.ts",
|
|
6579
|
-
"line":
|
|
7042
|
+
"line": 46
|
|
6580
7043
|
},
|
|
6581
7044
|
"name": "serviceDashboard",
|
|
6582
7045
|
"optional": true,
|
|
@@ -6597,7 +7060,7 @@
|
|
|
6597
7060
|
"kind": "interface",
|
|
6598
7061
|
"locationInModule": {
|
|
6599
7062
|
"filename": "src/services/IOperation.ts",
|
|
6600
|
-
"line":
|
|
7063
|
+
"line": 15
|
|
6601
7064
|
},
|
|
6602
7065
|
"name": "IOperation",
|
|
6603
7066
|
"properties": [
|
|
@@ -6610,7 +7073,7 @@
|
|
|
6610
7073
|
"immutable": true,
|
|
6611
7074
|
"locationInModule": {
|
|
6612
7075
|
"filename": "src/services/IOperation.ts",
|
|
6613
|
-
"line":
|
|
7076
|
+
"line": 71
|
|
6614
7077
|
},
|
|
6615
7078
|
"name": "critical",
|
|
6616
7079
|
"type": {
|
|
@@ -6626,7 +7089,7 @@
|
|
|
6626
7089
|
"immutable": true,
|
|
6627
7090
|
"locationInModule": {
|
|
6628
7091
|
"filename": "src/services/IOperation.ts",
|
|
6629
|
-
"line":
|
|
7092
|
+
"line": 76
|
|
6630
7093
|
},
|
|
6631
7094
|
"name": "httpMethods",
|
|
6632
7095
|
"type": {
|
|
@@ -6647,7 +7110,7 @@
|
|
|
6647
7110
|
"immutable": true,
|
|
6648
7111
|
"locationInModule": {
|
|
6649
7112
|
"filename": "src/services/IOperation.ts",
|
|
6650
|
-
"line":
|
|
7113
|
+
"line": 24
|
|
6651
7114
|
},
|
|
6652
7115
|
"name": "operationName",
|
|
6653
7116
|
"type": {
|
|
@@ -6663,7 +7126,7 @@
|
|
|
6663
7126
|
"immutable": true,
|
|
6664
7127
|
"locationInModule": {
|
|
6665
7128
|
"filename": "src/services/IOperation.ts",
|
|
6666
|
-
"line":
|
|
7129
|
+
"line": 30
|
|
6667
7130
|
},
|
|
6668
7131
|
"name": "path",
|
|
6669
7132
|
"type": {
|
|
@@ -6679,11 +7142,11 @@
|
|
|
6679
7142
|
"immutable": true,
|
|
6680
7143
|
"locationInModule": {
|
|
6681
7144
|
"filename": "src/services/IOperation.ts",
|
|
6682
|
-
"line":
|
|
7145
|
+
"line": 35
|
|
6683
7146
|
},
|
|
6684
7147
|
"name": "serverSideAvailabilityMetricDetails",
|
|
6685
7148
|
"type": {
|
|
6686
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
7149
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
6687
7150
|
}
|
|
6688
7151
|
},
|
|
6689
7152
|
{
|
|
@@ -6695,11 +7158,11 @@
|
|
|
6695
7158
|
"immutable": true,
|
|
6696
7159
|
"locationInModule": {
|
|
6697
7160
|
"filename": "src/services/IOperation.ts",
|
|
6698
|
-
"line":
|
|
7161
|
+
"line": 40
|
|
6699
7162
|
},
|
|
6700
7163
|
"name": "serverSideLatencyMetricDetails",
|
|
6701
7164
|
"type": {
|
|
6702
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
7165
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
6703
7166
|
}
|
|
6704
7167
|
},
|
|
6705
7168
|
{
|
|
@@ -6711,7 +7174,7 @@
|
|
|
6711
7174
|
"immutable": true,
|
|
6712
7175
|
"locationInModule": {
|
|
6713
7176
|
"filename": "src/services/IOperation.ts",
|
|
6714
|
-
"line":
|
|
7177
|
+
"line": 19
|
|
6715
7178
|
},
|
|
6716
7179
|
"name": "service",
|
|
6717
7180
|
"type": {
|
|
@@ -6727,7 +7190,7 @@
|
|
|
6727
7190
|
"immutable": true,
|
|
6728
7191
|
"locationInModule": {
|
|
6729
7192
|
"filename": "src/services/IOperation.ts",
|
|
6730
|
-
"line":
|
|
7193
|
+
"line": 45
|
|
6731
7194
|
},
|
|
6732
7195
|
"name": "canaryMetricDetails",
|
|
6733
7196
|
"optional": true,
|
|
@@ -6744,12 +7207,12 @@
|
|
|
6744
7207
|
"immutable": true,
|
|
6745
7208
|
"locationInModule": {
|
|
6746
7209
|
"filename": "src/services/IOperation.ts",
|
|
6747
|
-
"line":
|
|
7210
|
+
"line": 52
|
|
6748
7211
|
},
|
|
6749
7212
|
"name": "canaryTestAvailabilityMetricsOverride",
|
|
6750
7213
|
"optional": true,
|
|
6751
7214
|
"type": {
|
|
6752
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
7215
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestAvailabilityMetricsOverride"
|
|
6753
7216
|
}
|
|
6754
7217
|
},
|
|
6755
7218
|
{
|
|
@@ -6761,12 +7224,12 @@
|
|
|
6761
7224
|
"immutable": true,
|
|
6762
7225
|
"locationInModule": {
|
|
6763
7226
|
"filename": "src/services/IOperation.ts",
|
|
6764
|
-
"line":
|
|
7227
|
+
"line": 59
|
|
6765
7228
|
},
|
|
6766
7229
|
"name": "canaryTestLatencyMetricsOverride",
|
|
6767
7230
|
"optional": true,
|
|
6768
7231
|
"type": {
|
|
6769
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
7232
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestLatencyMetricsOverride"
|
|
6770
7233
|
}
|
|
6771
7234
|
},
|
|
6772
7235
|
{
|
|
@@ -6778,7 +7241,7 @@
|
|
|
6778
7241
|
"immutable": true,
|
|
6779
7242
|
"locationInModule": {
|
|
6780
7243
|
"filename": "src/services/IOperation.ts",
|
|
6781
|
-
"line":
|
|
7244
|
+
"line": 82
|
|
6782
7245
|
},
|
|
6783
7246
|
"name": "canaryTestProps",
|
|
6784
7247
|
"optional": true,
|
|
@@ -6796,7 +7259,7 @@
|
|
|
6796
7259
|
"immutable": true,
|
|
6797
7260
|
"locationInModule": {
|
|
6798
7261
|
"filename": "src/services/IOperation.ts",
|
|
6799
|
-
"line":
|
|
7262
|
+
"line": 91
|
|
6800
7263
|
},
|
|
6801
7264
|
"name": "optOutOfServiceCreatedCanary",
|
|
6802
7265
|
"optional": true,
|
|
@@ -6813,7 +7276,7 @@
|
|
|
6813
7276
|
"immutable": true,
|
|
6814
7277
|
"locationInModule": {
|
|
6815
7278
|
"filename": "src/services/IOperation.ts",
|
|
6816
|
-
"line":
|
|
7279
|
+
"line": 64
|
|
6817
7280
|
},
|
|
6818
7281
|
"name": "serverSideContributorInsightRuleDetails",
|
|
6819
7282
|
"optional": true,
|
|
@@ -6824,64 +7287,182 @@
|
|
|
6824
7287
|
],
|
|
6825
7288
|
"symbolId": "src/services/IOperation:IOperation"
|
|
6826
7289
|
},
|
|
6827
|
-
"@cdklabs/multi-az-observability.
|
|
7290
|
+
"@cdklabs/multi-az-observability.IOperationAlarmsAndRules": {
|
|
6828
7291
|
"assembly": "@cdklabs/multi-az-observability",
|
|
6829
7292
|
"docs": {
|
|
6830
7293
|
"stability": "experimental",
|
|
6831
|
-
"summary": "
|
|
7294
|
+
"summary": "Creates alarms and rules for an operation for both regional and zonal metrics."
|
|
6832
7295
|
},
|
|
6833
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
7296
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAlarmsAndRules",
|
|
6834
7297
|
"kind": "interface",
|
|
6835
7298
|
"locationInModule": {
|
|
6836
|
-
"filename": "src/
|
|
6837
|
-
"line":
|
|
7299
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7300
|
+
"line": 13
|
|
6838
7301
|
},
|
|
6839
|
-
"name": "
|
|
7302
|
+
"name": "IOperationAlarmsAndRules",
|
|
6840
7303
|
"properties": [
|
|
6841
7304
|
{
|
|
6842
7305
|
"abstract": true,
|
|
6843
7306
|
"docs": {
|
|
6844
7307
|
"stability": "experimental",
|
|
6845
|
-
"summary": "The
|
|
7308
|
+
"summary": "The aggregate, server-side and canary combined, zonal alarm indexed by Availability Zone name."
|
|
6846
7309
|
},
|
|
6847
7310
|
"immutable": true,
|
|
6848
7311
|
"locationInModule": {
|
|
6849
|
-
"filename": "src/
|
|
6850
|
-
"line":
|
|
7312
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7313
|
+
"line": 38
|
|
6851
7314
|
},
|
|
6852
|
-
"name": "
|
|
7315
|
+
"name": "aggregateZonalAlarms",
|
|
6853
7316
|
"type": {
|
|
6854
|
-
"
|
|
7317
|
+
"collection": {
|
|
7318
|
+
"elementtype": {
|
|
7319
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
7320
|
+
},
|
|
7321
|
+
"kind": "map"
|
|
7322
|
+
}
|
|
6855
7323
|
}
|
|
6856
7324
|
},
|
|
6857
7325
|
{
|
|
6858
7326
|
"abstract": true,
|
|
6859
7327
|
"docs": {
|
|
6860
7328
|
"stability": "experimental",
|
|
6861
|
-
"summary": "The
|
|
7329
|
+
"summary": "The operation the alarms and rules are created for."
|
|
6862
7330
|
},
|
|
6863
7331
|
"immutable": true,
|
|
6864
7332
|
"locationInModule": {
|
|
6865
|
-
"filename": "src/
|
|
6866
|
-
"line":
|
|
7333
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7334
|
+
"line": 17
|
|
6867
7335
|
},
|
|
6868
|
-
"name": "
|
|
7336
|
+
"name": "operation",
|
|
6869
7337
|
"type": {
|
|
6870
|
-
"
|
|
7338
|
+
"fqn": "@cdklabs/multi-az-observability.IOperation"
|
|
6871
7339
|
}
|
|
6872
7340
|
},
|
|
6873
7341
|
{
|
|
6874
7342
|
"abstract": true,
|
|
6875
7343
|
"docs": {
|
|
6876
7344
|
"stability": "experimental",
|
|
6877
|
-
"summary": "
|
|
7345
|
+
"summary": "An alarm indicating availability or latency impact has been detected by the server-side and/or canary (if present) and the impact is regionally scoped, not zonal."
|
|
6878
7346
|
},
|
|
6879
7347
|
"immutable": true,
|
|
6880
7348
|
"locationInModule": {
|
|
6881
|
-
"filename": "src/
|
|
6882
|
-
"line":
|
|
7349
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7350
|
+
"line": 23
|
|
6883
7351
|
},
|
|
6884
|
-
"name": "
|
|
7352
|
+
"name": "regionalImpactAlarm",
|
|
7353
|
+
"type": {
|
|
7354
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
7355
|
+
}
|
|
7356
|
+
},
|
|
7357
|
+
{
|
|
7358
|
+
"abstract": true,
|
|
7359
|
+
"docs": {
|
|
7360
|
+
"stability": "experimental",
|
|
7361
|
+
"summary": "The server side regional alarms and rules."
|
|
7362
|
+
},
|
|
7363
|
+
"immutable": true,
|
|
7364
|
+
"locationInModule": {
|
|
7365
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7366
|
+
"line": 28
|
|
7367
|
+
},
|
|
7368
|
+
"name": "serverSideRegionalAlarmsAndRules",
|
|
7369
|
+
"type": {
|
|
7370
|
+
"fqn": "@cdklabs/multi-az-observability.IServerSideOperationRegionalAlarmsAndRules"
|
|
7371
|
+
}
|
|
7372
|
+
},
|
|
7373
|
+
{
|
|
7374
|
+
"abstract": true,
|
|
7375
|
+
"docs": {
|
|
7376
|
+
"stability": "experimental",
|
|
7377
|
+
"summary": "The server side zonal alarms and rules, indexed by Availability Zone name."
|
|
7378
|
+
},
|
|
7379
|
+
"immutable": true,
|
|
7380
|
+
"locationInModule": {
|
|
7381
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7382
|
+
"line": 43
|
|
7383
|
+
},
|
|
7384
|
+
"name": "serverSideZonalAlarmsAndRules",
|
|
7385
|
+
"type": {
|
|
7386
|
+
"collection": {
|
|
7387
|
+
"elementtype": {
|
|
7388
|
+
"fqn": "@cdklabs/multi-az-observability.IServerSideOperationZonalAlarmsAndRules"
|
|
7389
|
+
},
|
|
7390
|
+
"kind": "map"
|
|
7391
|
+
}
|
|
7392
|
+
}
|
|
7393
|
+
},
|
|
7394
|
+
{
|
|
7395
|
+
"abstract": true,
|
|
7396
|
+
"docs": {
|
|
7397
|
+
"stability": "experimental",
|
|
7398
|
+
"summary": "The canary regional alarms and rules."
|
|
7399
|
+
},
|
|
7400
|
+
"immutable": true,
|
|
7401
|
+
"locationInModule": {
|
|
7402
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7403
|
+
"line": 33
|
|
7404
|
+
},
|
|
7405
|
+
"name": "canaryRegionalAlarmsAndRules",
|
|
7406
|
+
"optional": true,
|
|
7407
|
+
"type": {
|
|
7408
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryOperationRegionalAlarmsAndRules"
|
|
7409
|
+
}
|
|
7410
|
+
},
|
|
7411
|
+
{
|
|
7412
|
+
"abstract": true,
|
|
7413
|
+
"docs": {
|
|
7414
|
+
"default": "- This is an empty dictionary if canary metric details are not provided",
|
|
7415
|
+
"stability": "experimental",
|
|
7416
|
+
"summary": "The canary zonal alarms and rules, indexed by Availability Zone name."
|
|
7417
|
+
},
|
|
7418
|
+
"immutable": true,
|
|
7419
|
+
"locationInModule": {
|
|
7420
|
+
"filename": "src/alarmsandrules/IOperationAlarmsAndRules.ts",
|
|
7421
|
+
"line": 50
|
|
7422
|
+
},
|
|
7423
|
+
"name": "canaryZonalAlarmsAndRules",
|
|
7424
|
+
"optional": true,
|
|
7425
|
+
"type": {
|
|
7426
|
+
"collection": {
|
|
7427
|
+
"elementtype": {
|
|
7428
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryOperationZonalAlarmsAndRules"
|
|
7429
|
+
},
|
|
7430
|
+
"kind": "map"
|
|
7431
|
+
}
|
|
7432
|
+
}
|
|
7433
|
+
}
|
|
7434
|
+
],
|
|
7435
|
+
"symbolId": "src/alarmsandrules/IOperationAlarmsAndRules:IOperationAlarmsAndRules"
|
|
7436
|
+
},
|
|
7437
|
+
"@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails": {
|
|
7438
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
7439
|
+
"docs": {
|
|
7440
|
+
"stability": "experimental",
|
|
7441
|
+
"summary": "Details for operation metrics in one perspective, such as server side latency."
|
|
7442
|
+
},
|
|
7443
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails",
|
|
7444
|
+
"interfaces": [
|
|
7445
|
+
"@cdklabs/multi-az-observability.IOperationMetricDetails"
|
|
7446
|
+
],
|
|
7447
|
+
"kind": "interface",
|
|
7448
|
+
"locationInModule": {
|
|
7449
|
+
"filename": "src/services/IOperationAvailabilityMetricDetails.ts",
|
|
7450
|
+
"line": 8
|
|
7451
|
+
},
|
|
7452
|
+
"name": "IOperationAvailabilityMetricDetails",
|
|
7453
|
+
"properties": [
|
|
7454
|
+
{
|
|
7455
|
+
"abstract": true,
|
|
7456
|
+
"docs": {
|
|
7457
|
+
"stability": "experimental",
|
|
7458
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
7459
|
+
},
|
|
7460
|
+
"immutable": true,
|
|
7461
|
+
"locationInModule": {
|
|
7462
|
+
"filename": "src/services/IOperationAvailabilityMetricDetails.ts",
|
|
7463
|
+
"line": 21
|
|
7464
|
+
},
|
|
7465
|
+
"name": "faultAlarmThreshold",
|
|
6885
7466
|
"type": {
|
|
6886
7467
|
"primitive": "number"
|
|
6887
7468
|
}
|
|
@@ -6890,14 +7471,115 @@
|
|
|
6890
7471
|
"abstract": true,
|
|
6891
7472
|
"docs": {
|
|
6892
7473
|
"stability": "experimental",
|
|
6893
|
-
"summary": "The threshold for alarms associated with
|
|
7474
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
7475
|
+
},
|
|
7476
|
+
"immutable": true,
|
|
7477
|
+
"locationInModule": {
|
|
7478
|
+
"filename": "src/services/IOperationAvailabilityMetricDetails.ts",
|
|
7479
|
+
"line": 14
|
|
7480
|
+
},
|
|
7481
|
+
"name": "successAlarmThreshold",
|
|
7482
|
+
"type": {
|
|
7483
|
+
"primitive": "number"
|
|
7484
|
+
}
|
|
7485
|
+
}
|
|
7486
|
+
],
|
|
7487
|
+
"symbolId": "src/services/IOperationAvailabilityMetricDetails:IOperationAvailabilityMetricDetails"
|
|
7488
|
+
},
|
|
7489
|
+
"@cdklabs/multi-az-observability.IOperationLatencyMetricDetails": {
|
|
7490
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
7491
|
+
"docs": {
|
|
7492
|
+
"stability": "experimental",
|
|
7493
|
+
"summary": "Details for operation metrics in one perspective, such as server side latency."
|
|
7494
|
+
},
|
|
7495
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails",
|
|
7496
|
+
"interfaces": [
|
|
7497
|
+
"@cdklabs/multi-az-observability.IOperationMetricDetails"
|
|
7498
|
+
],
|
|
7499
|
+
"kind": "interface",
|
|
7500
|
+
"locationInModule": {
|
|
7501
|
+
"filename": "src/services/IOperationLatencyMetricDetails.ts",
|
|
7502
|
+
"line": 9
|
|
7503
|
+
},
|
|
7504
|
+
"name": "IOperationLatencyMetricDetails",
|
|
7505
|
+
"properties": [
|
|
7506
|
+
{
|
|
7507
|
+
"abstract": true,
|
|
7508
|
+
"docs": {
|
|
7509
|
+
"stability": "experimental",
|
|
7510
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
7511
|
+
},
|
|
7512
|
+
"immutable": true,
|
|
7513
|
+
"locationInModule": {
|
|
7514
|
+
"filename": "src/services/IOperationLatencyMetricDetails.ts",
|
|
7515
|
+
"line": 14
|
|
7516
|
+
},
|
|
7517
|
+
"name": "successAlarmThreshold",
|
|
7518
|
+
"type": {
|
|
7519
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
7520
|
+
}
|
|
7521
|
+
}
|
|
7522
|
+
],
|
|
7523
|
+
"symbolId": "src/services/IOperationLatencyMetricDetails:IOperationLatencyMetricDetails"
|
|
7524
|
+
},
|
|
7525
|
+
"@cdklabs/multi-az-observability.IOperationMetricDetails": {
|
|
7526
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
7527
|
+
"docs": {
|
|
7528
|
+
"stability": "experimental",
|
|
7529
|
+
"summary": "Details for operation metrics in one perspective, such as server side latency."
|
|
7530
|
+
},
|
|
7531
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationMetricDetails",
|
|
7532
|
+
"kind": "interface",
|
|
7533
|
+
"locationInModule": {
|
|
7534
|
+
"filename": "src/services/IOperationMetricDetails.ts",
|
|
7535
|
+
"line": 10
|
|
7536
|
+
},
|
|
7537
|
+
"name": "IOperationMetricDetails",
|
|
7538
|
+
"properties": [
|
|
7539
|
+
{
|
|
7540
|
+
"abstract": true,
|
|
7541
|
+
"docs": {
|
|
7542
|
+
"stability": "experimental",
|
|
7543
|
+
"summary": "The statistic used for alarms, for availability metrics this should be \"Sum\", for latency metrics it could something like \"p99\" or \"p99.9\"."
|
|
6894
7544
|
},
|
|
6895
7545
|
"immutable": true,
|
|
6896
7546
|
"locationInModule": {
|
|
6897
7547
|
"filename": "src/services/IOperationMetricDetails.ts",
|
|
6898
|
-
"line":
|
|
7548
|
+
"line": 35
|
|
6899
7549
|
},
|
|
6900
|
-
"name": "
|
|
7550
|
+
"name": "alarmStatistic",
|
|
7551
|
+
"type": {
|
|
7552
|
+
"primitive": "string"
|
|
7553
|
+
}
|
|
7554
|
+
},
|
|
7555
|
+
{
|
|
7556
|
+
"abstract": true,
|
|
7557
|
+
"docs": {
|
|
7558
|
+
"stability": "experimental",
|
|
7559
|
+
"summary": "The number of datapoints to alarm on for latency and availability alarms."
|
|
7560
|
+
},
|
|
7561
|
+
"immutable": true,
|
|
7562
|
+
"locationInModule": {
|
|
7563
|
+
"filename": "src/services/IOperationMetricDetails.ts",
|
|
7564
|
+
"line": 73
|
|
7565
|
+
},
|
|
7566
|
+
"name": "datapointsToAlarm",
|
|
7567
|
+
"type": {
|
|
7568
|
+
"primitive": "number"
|
|
7569
|
+
}
|
|
7570
|
+
},
|
|
7571
|
+
{
|
|
7572
|
+
"abstract": true,
|
|
7573
|
+
"docs": {
|
|
7574
|
+
"stability": "experimental",
|
|
7575
|
+
"summary": "The number of evaluation periods for latency and availabiltiy alarms."
|
|
7576
|
+
},
|
|
7577
|
+
"immutable": true,
|
|
7578
|
+
"locationInModule": {
|
|
7579
|
+
"filename": "src/services/IOperationMetricDetails.ts",
|
|
7580
|
+
"line": 68
|
|
7581
|
+
},
|
|
7582
|
+
"name": "evaluationPeriods",
|
|
6901
7583
|
"type": {
|
|
6902
7584
|
"primitive": "number"
|
|
6903
7585
|
}
|
|
@@ -6932,7 +7614,7 @@
|
|
|
6932
7614
|
"immutable": true,
|
|
6933
7615
|
"locationInModule": {
|
|
6934
7616
|
"filename": "src/services/IOperationMetricDetails.ts",
|
|
6935
|
-
"line":
|
|
7617
|
+
"line": 79
|
|
6936
7618
|
},
|
|
6937
7619
|
"name": "metricDimensions",
|
|
6938
7620
|
"type": {
|
|
@@ -6987,22 +7669,6 @@
|
|
|
6987
7669
|
"fqn": "aws-cdk-lib.Duration"
|
|
6988
7670
|
}
|
|
6989
7671
|
},
|
|
6990
|
-
{
|
|
6991
|
-
"abstract": true,
|
|
6992
|
-
"docs": {
|
|
6993
|
-
"stability": "experimental",
|
|
6994
|
-
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
6995
|
-
},
|
|
6996
|
-
"immutable": true,
|
|
6997
|
-
"locationInModule": {
|
|
6998
|
-
"filename": "src/services/IOperationMetricDetails.ts",
|
|
6999
|
-
"line": 80
|
|
7000
|
-
},
|
|
7001
|
-
"name": "successAlarmThreshold",
|
|
7002
|
-
"type": {
|
|
7003
|
-
"primitive": "number"
|
|
7004
|
-
}
|
|
7005
|
-
},
|
|
7006
7672
|
{
|
|
7007
7673
|
"abstract": true,
|
|
7008
7674
|
"docs": {
|
|
@@ -7091,6 +7757,173 @@
|
|
|
7091
7757
|
],
|
|
7092
7758
|
"symbolId": "src/services/IOperationMetricDetails:IOperationMetricDetails"
|
|
7093
7759
|
},
|
|
7760
|
+
"@cdklabs/multi-az-observability.IServerSideOperationRegionalAlarmsAndRules": {
|
|
7761
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
7762
|
+
"docs": {
|
|
7763
|
+
"stability": "experimental",
|
|
7764
|
+
"summary": "The server side operation regional alarms and rules."
|
|
7765
|
+
},
|
|
7766
|
+
"fqn": "@cdklabs/multi-az-observability.IServerSideOperationRegionalAlarmsAndRules",
|
|
7767
|
+
"interfaces": [
|
|
7768
|
+
"@cdklabs/multi-az-observability.IBaseOperationRegionalAlarmsAndRules"
|
|
7769
|
+
],
|
|
7770
|
+
"kind": "interface",
|
|
7771
|
+
"locationInModule": {
|
|
7772
|
+
"filename": "src/alarmsandrules/IServerSideOperationRegionalAlarmsAndRules.ts",
|
|
7773
|
+
"line": 9
|
|
7774
|
+
},
|
|
7775
|
+
"name": "IServerSideOperationRegionalAlarmsAndRules",
|
|
7776
|
+
"properties": [
|
|
7777
|
+
{
|
|
7778
|
+
"abstract": true,
|
|
7779
|
+
"docs": {
|
|
7780
|
+
"stability": "experimental",
|
|
7781
|
+
"summary": "A rule that shows which instances are contributing to faults."
|
|
7782
|
+
},
|
|
7783
|
+
"locationInModule": {
|
|
7784
|
+
"filename": "src/alarmsandrules/IServerSideOperationRegionalAlarmsAndRules.ts",
|
|
7785
|
+
"line": 18
|
|
7786
|
+
},
|
|
7787
|
+
"name": "instanceContributorsToRegionalFaults",
|
|
7788
|
+
"optional": true,
|
|
7789
|
+
"type": {
|
|
7790
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.CfnInsightRule"
|
|
7791
|
+
}
|
|
7792
|
+
},
|
|
7793
|
+
{
|
|
7794
|
+
"abstract": true,
|
|
7795
|
+
"docs": {
|
|
7796
|
+
"stability": "experimental",
|
|
7797
|
+
"summary": "A rule that shows which instances are contributing to high latency responses."
|
|
7798
|
+
},
|
|
7799
|
+
"locationInModule": {
|
|
7800
|
+
"filename": "src/alarmsandrules/IServerSideOperationRegionalAlarmsAndRules.ts",
|
|
7801
|
+
"line": 13
|
|
7802
|
+
},
|
|
7803
|
+
"name": "instanceContributorsToRegionalHighLatency",
|
|
7804
|
+
"optional": true,
|
|
7805
|
+
"type": {
|
|
7806
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.CfnInsightRule"
|
|
7807
|
+
}
|
|
7808
|
+
}
|
|
7809
|
+
],
|
|
7810
|
+
"symbolId": "src/alarmsandrules/IServerSideOperationRegionalAlarmsAndRules:IServerSideOperationRegionalAlarmsAndRules"
|
|
7811
|
+
},
|
|
7812
|
+
"@cdklabs/multi-az-observability.IServerSideOperationZonalAlarmsAndRules": {
|
|
7813
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
7814
|
+
"docs": {
|
|
7815
|
+
"stability": "experimental",
|
|
7816
|
+
"summary": "Server side opertaion zonal alarms and rules."
|
|
7817
|
+
},
|
|
7818
|
+
"fqn": "@cdklabs/multi-az-observability.IServerSideOperationZonalAlarmsAndRules",
|
|
7819
|
+
"interfaces": [
|
|
7820
|
+
"@cdklabs/multi-az-observability.IBaseOperationZonalAlarmsAndRules"
|
|
7821
|
+
],
|
|
7822
|
+
"kind": "interface",
|
|
7823
|
+
"locationInModule": {
|
|
7824
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7825
|
+
"line": 9
|
|
7826
|
+
},
|
|
7827
|
+
"name": "IServerSideOperationZonalAlarmsAndRules",
|
|
7828
|
+
"properties": [
|
|
7829
|
+
{
|
|
7830
|
+
"abstract": true,
|
|
7831
|
+
"docs": {
|
|
7832
|
+
"stability": "experimental",
|
|
7833
|
+
"summary": "Alarm that triggers if either latency or availability breach the specified threshold in this AZ and the AZ is an outlier for faults or latency."
|
|
7834
|
+
},
|
|
7835
|
+
"locationInModule": {
|
|
7836
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7837
|
+
"line": 15
|
|
7838
|
+
},
|
|
7839
|
+
"name": "isolatedImpactAlarm",
|
|
7840
|
+
"type": {
|
|
7841
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
7842
|
+
}
|
|
7843
|
+
},
|
|
7844
|
+
{
|
|
7845
|
+
"abstract": true,
|
|
7846
|
+
"docs": {
|
|
7847
|
+
"stability": "experimental",
|
|
7848
|
+
"summary": "Insight rule that measures the number of instances contributing to faults in this AZ."
|
|
7849
|
+
},
|
|
7850
|
+
"locationInModule": {
|
|
7851
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7852
|
+
"line": 38
|
|
7853
|
+
},
|
|
7854
|
+
"name": "instanceContributorsToFaultsInThisAZ",
|
|
7855
|
+
"optional": true,
|
|
7856
|
+
"type": {
|
|
7857
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.CfnInsightRule"
|
|
7858
|
+
}
|
|
7859
|
+
},
|
|
7860
|
+
{
|
|
7861
|
+
"abstract": true,
|
|
7862
|
+
"docs": {
|
|
7863
|
+
"stability": "experimental",
|
|
7864
|
+
"summary": "Insight rule that measures the number of instances contributing to high latency in this AZ."
|
|
7865
|
+
},
|
|
7866
|
+
"locationInModule": {
|
|
7867
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7868
|
+
"line": 33
|
|
7869
|
+
},
|
|
7870
|
+
"name": "instanceContributorsToHighLatencyInThisAZ",
|
|
7871
|
+
"optional": true,
|
|
7872
|
+
"type": {
|
|
7873
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.CfnInsightRule"
|
|
7874
|
+
}
|
|
7875
|
+
},
|
|
7876
|
+
{
|
|
7877
|
+
"abstract": true,
|
|
7878
|
+
"docs": {
|
|
7879
|
+
"stability": "experimental",
|
|
7880
|
+
"summary": "Insight rule that is used to calculate the number of instances in this particular AZ that is used with metric math to calculate the percent of instances contributing to latency or faults."
|
|
7881
|
+
},
|
|
7882
|
+
"locationInModule": {
|
|
7883
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7884
|
+
"line": 44
|
|
7885
|
+
},
|
|
7886
|
+
"name": "instancesHandlingRequestsInThisAZ",
|
|
7887
|
+
"optional": true,
|
|
7888
|
+
"type": {
|
|
7889
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.CfnInsightRule"
|
|
7890
|
+
}
|
|
7891
|
+
},
|
|
7892
|
+
{
|
|
7893
|
+
"abstract": true,
|
|
7894
|
+
"docs": {
|
|
7895
|
+
"stability": "experimental",
|
|
7896
|
+
"summary": "Alarm indicating that there are multiple instances producing faults in this AZ indicating the fault rate is not being caused by a single instance."
|
|
7897
|
+
},
|
|
7898
|
+
"locationInModule": {
|
|
7899
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7900
|
+
"line": 21
|
|
7901
|
+
},
|
|
7902
|
+
"name": "multipleInstancesProducingFaultsInThisAvailabilityZone",
|
|
7903
|
+
"optional": true,
|
|
7904
|
+
"type": {
|
|
7905
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
7906
|
+
}
|
|
7907
|
+
},
|
|
7908
|
+
{
|
|
7909
|
+
"abstract": true,
|
|
7910
|
+
"docs": {
|
|
7911
|
+
"stability": "experimental",
|
|
7912
|
+
"summary": "Alarm indicating that there are multiple instances producing high latency responses in this AZ indicating the latency is not being caused by a single instance."
|
|
7913
|
+
},
|
|
7914
|
+
"locationInModule": {
|
|
7915
|
+
"filename": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules.ts",
|
|
7916
|
+
"line": 28
|
|
7917
|
+
},
|
|
7918
|
+
"name": "multipleInstancesProducingHighLatencyInThisAZ",
|
|
7919
|
+
"optional": true,
|
|
7920
|
+
"type": {
|
|
7921
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
7922
|
+
}
|
|
7923
|
+
}
|
|
7924
|
+
],
|
|
7925
|
+
"symbolId": "src/alarmsandrules/IServerSideOperationZonalAlarmsAndRules:IServerSideOperationZonalAlarmsAndRules"
|
|
7926
|
+
},
|
|
7094
7927
|
"@cdklabs/multi-az-observability.IService": {
|
|
7095
7928
|
"assembly": "@cdklabs/multi-az-observability",
|
|
7096
7929
|
"docs": {
|
|
@@ -7101,7 +7934,7 @@
|
|
|
7101
7934
|
"kind": "interface",
|
|
7102
7935
|
"locationInModule": {
|
|
7103
7936
|
"filename": "src/services/IService.ts",
|
|
7104
|
-
"line":
|
|
7937
|
+
"line": 14
|
|
7105
7938
|
},
|
|
7106
7939
|
"methods": [
|
|
7107
7940
|
{
|
|
@@ -7112,7 +7945,7 @@
|
|
|
7112
7945
|
},
|
|
7113
7946
|
"locationInModule": {
|
|
7114
7947
|
"filename": "src/services/IService.ts",
|
|
7115
|
-
"line":
|
|
7948
|
+
"line": 90
|
|
7116
7949
|
},
|
|
7117
7950
|
"name": "addOperation",
|
|
7118
7951
|
"parameters": [
|
|
@@ -7136,7 +7969,7 @@
|
|
|
7136
7969
|
"immutable": true,
|
|
7137
7970
|
"locationInModule": {
|
|
7138
7971
|
"filename": "src/services/IService.ts",
|
|
7139
|
-
"line":
|
|
7972
|
+
"line": 34
|
|
7140
7973
|
},
|
|
7141
7974
|
"name": "availabilityZoneNames",
|
|
7142
7975
|
"type": {
|
|
@@ -7157,7 +7990,7 @@
|
|
|
7157
7990
|
"immutable": true,
|
|
7158
7991
|
"locationInModule": {
|
|
7159
7992
|
"filename": "src/services/IService.ts",
|
|
7160
|
-
"line":
|
|
7993
|
+
"line": 23
|
|
7161
7994
|
},
|
|
7162
7995
|
"name": "baseUrl",
|
|
7163
7996
|
"type": {
|
|
@@ -7173,11 +8006,11 @@
|
|
|
7173
8006
|
"immutable": true,
|
|
7174
8007
|
"locationInModule": {
|
|
7175
8008
|
"filename": "src/services/IService.ts",
|
|
7176
|
-
"line":
|
|
8009
|
+
"line": 70
|
|
7177
8010
|
},
|
|
7178
8011
|
"name": "defaultAvailabilityMetricDetails",
|
|
7179
8012
|
"type": {
|
|
7180
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
8013
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails"
|
|
7181
8014
|
}
|
|
7182
8015
|
},
|
|
7183
8016
|
{
|
|
@@ -7189,11 +8022,11 @@
|
|
|
7189
8022
|
"immutable": true,
|
|
7190
8023
|
"locationInModule": {
|
|
7191
8024
|
"filename": "src/services/IService.ts",
|
|
7192
|
-
"line":
|
|
8025
|
+
"line": 77
|
|
7193
8026
|
},
|
|
7194
8027
|
"name": "defaultLatencyMetricDetails",
|
|
7195
8028
|
"type": {
|
|
7196
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
8029
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceLatencyMetricDetails"
|
|
7197
8030
|
}
|
|
7198
8031
|
},
|
|
7199
8032
|
{
|
|
@@ -7206,7 +8039,7 @@
|
|
|
7206
8039
|
"immutable": true,
|
|
7207
8040
|
"locationInModule": {
|
|
7208
8041
|
"filename": "src/services/IService.ts",
|
|
7209
|
-
"line":
|
|
8042
|
+
"line": 29
|
|
7210
8043
|
},
|
|
7211
8044
|
"name": "faultCountThreshold",
|
|
7212
8045
|
"type": {
|
|
@@ -7222,7 +8055,7 @@
|
|
|
7222
8055
|
"immutable": true,
|
|
7223
8056
|
"locationInModule": {
|
|
7224
8057
|
"filename": "src/services/IService.ts",
|
|
7225
|
-
"line":
|
|
8058
|
+
"line": 44
|
|
7226
8059
|
},
|
|
7227
8060
|
"name": "operations",
|
|
7228
8061
|
"type": {
|
|
@@ -7243,7 +8076,7 @@
|
|
|
7243
8076
|
"immutable": true,
|
|
7244
8077
|
"locationInModule": {
|
|
7245
8078
|
"filename": "src/services/IService.ts",
|
|
7246
|
-
"line":
|
|
8079
|
+
"line": 39
|
|
7247
8080
|
},
|
|
7248
8081
|
"name": "period",
|
|
7249
8082
|
"type": {
|
|
@@ -7259,7 +8092,7 @@
|
|
|
7259
8092
|
"immutable": true,
|
|
7260
8093
|
"locationInModule": {
|
|
7261
8094
|
"filename": "src/services/IService.ts",
|
|
7262
|
-
"line":
|
|
8095
|
+
"line": 18
|
|
7263
8096
|
},
|
|
7264
8097
|
"name": "serviceName",
|
|
7265
8098
|
"type": {
|
|
@@ -7277,7 +8110,7 @@
|
|
|
7277
8110
|
"immutable": true,
|
|
7278
8111
|
"locationInModule": {
|
|
7279
8112
|
"filename": "src/services/IService.ts",
|
|
7280
|
-
"line":
|
|
8113
|
+
"line": 63
|
|
7281
8114
|
},
|
|
7282
8115
|
"name": "canaryTestProps",
|
|
7283
8116
|
"optional": true,
|
|
@@ -7295,7 +8128,7 @@
|
|
|
7295
8128
|
"immutable": true,
|
|
7296
8129
|
"locationInModule": {
|
|
7297
8130
|
"filename": "src/services/IService.ts",
|
|
7298
|
-
"line":
|
|
8131
|
+
"line": 85
|
|
7299
8132
|
},
|
|
7300
8133
|
"name": "defaultContributorInsightRuleDetails",
|
|
7301
8134
|
"optional": true,
|
|
@@ -7313,7 +8146,7 @@
|
|
|
7313
8146
|
"immutable": true,
|
|
7314
8147
|
"locationInModule": {
|
|
7315
8148
|
"filename": "src/services/IService.ts",
|
|
7316
|
-
"line":
|
|
8149
|
+
"line": 53
|
|
7317
8150
|
},
|
|
7318
8151
|
"name": "loadBalancer",
|
|
7319
8152
|
"optional": true,
|
|
@@ -7423,42 +8256,130 @@
|
|
|
7423
8256
|
{
|
|
7424
8257
|
"abstract": true,
|
|
7425
8258
|
"docs": {
|
|
7426
|
-
"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.",
|
|
8259
|
+
"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.",
|
|
8260
|
+
"stability": "experimental",
|
|
8261
|
+
"summary": "The zonal server-side isolated impact alarms."
|
|
8262
|
+
},
|
|
8263
|
+
"locationInModule": {
|
|
8264
|
+
"filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
|
|
8265
|
+
"line": 28
|
|
8266
|
+
},
|
|
8267
|
+
"name": "zonalServerSideIsolatedImpactAlarms",
|
|
8268
|
+
"type": {
|
|
8269
|
+
"collection": {
|
|
8270
|
+
"elementtype": {
|
|
8271
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
8272
|
+
},
|
|
8273
|
+
"kind": "map"
|
|
8274
|
+
}
|
|
8275
|
+
}
|
|
8276
|
+
},
|
|
8277
|
+
{
|
|
8278
|
+
"abstract": true,
|
|
8279
|
+
"docs": {
|
|
8280
|
+
"stability": "experimental",
|
|
8281
|
+
"summary": "An alarm indicating the canary has discovered an availability or latency impact on a critical operation while testing the regional endpoint."
|
|
8282
|
+
},
|
|
8283
|
+
"locationInModule": {
|
|
8284
|
+
"filename": "src/alarmsandrules/IServiceAlarmsAndRules.ts",
|
|
8285
|
+
"line": 34
|
|
8286
|
+
},
|
|
8287
|
+
"name": "regionalCanaryAlarm",
|
|
8288
|
+
"optional": true,
|
|
8289
|
+
"type": {
|
|
8290
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
8291
|
+
}
|
|
8292
|
+
}
|
|
8293
|
+
],
|
|
8294
|
+
"symbolId": "src/alarmsandrules/IServiceAlarmsAndRules:IServiceAlarmsAndRules"
|
|
8295
|
+
},
|
|
8296
|
+
"@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails": {
|
|
8297
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
8298
|
+
"docs": {
|
|
8299
|
+
"stability": "experimental",
|
|
8300
|
+
"summary": "Details for the defaults used in a service for metrics in one perspective, such as server side latency."
|
|
8301
|
+
},
|
|
8302
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails",
|
|
8303
|
+
"interfaces": [
|
|
8304
|
+
"@cdklabs/multi-az-observability.IServiceMetricDetails"
|
|
8305
|
+
],
|
|
8306
|
+
"kind": "interface",
|
|
8307
|
+
"locationInModule": {
|
|
8308
|
+
"filename": "src/services/IServiceAvailabilityMetricDetails.ts",
|
|
8309
|
+
"line": 8
|
|
8310
|
+
},
|
|
8311
|
+
"name": "IServiceAvailabilityMetricDetails",
|
|
8312
|
+
"properties": [
|
|
8313
|
+
{
|
|
8314
|
+
"abstract": true,
|
|
8315
|
+
"docs": {
|
|
8316
|
+
"stability": "experimental",
|
|
8317
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
8318
|
+
},
|
|
8319
|
+
"immutable": true,
|
|
8320
|
+
"locationInModule": {
|
|
8321
|
+
"filename": "src/services/IServiceAvailabilityMetricDetails.ts",
|
|
8322
|
+
"line": 21
|
|
8323
|
+
},
|
|
8324
|
+
"name": "faultAlarmThreshold",
|
|
8325
|
+
"type": {
|
|
8326
|
+
"primitive": "number"
|
|
8327
|
+
}
|
|
8328
|
+
},
|
|
8329
|
+
{
|
|
8330
|
+
"abstract": true,
|
|
8331
|
+
"docs": {
|
|
7427
8332
|
"stability": "experimental",
|
|
7428
|
-
"summary": "The
|
|
8333
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
7429
8334
|
},
|
|
8335
|
+
"immutable": true,
|
|
7430
8336
|
"locationInModule": {
|
|
7431
|
-
"filename": "src/
|
|
7432
|
-
"line":
|
|
8337
|
+
"filename": "src/services/IServiceAvailabilityMetricDetails.ts",
|
|
8338
|
+
"line": 14
|
|
7433
8339
|
},
|
|
7434
|
-
"name": "
|
|
8340
|
+
"name": "successAlarmThreshold",
|
|
7435
8341
|
"type": {
|
|
7436
|
-
"
|
|
7437
|
-
"elementtype": {
|
|
7438
|
-
"fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
|
|
7439
|
-
},
|
|
7440
|
-
"kind": "map"
|
|
7441
|
-
}
|
|
8342
|
+
"primitive": "number"
|
|
7442
8343
|
}
|
|
7443
|
-
}
|
|
8344
|
+
}
|
|
8345
|
+
],
|
|
8346
|
+
"symbolId": "src/services/IServiceAvailabilityMetricDetails:IServiceAvailabilityMetricDetails"
|
|
8347
|
+
},
|
|
8348
|
+
"@cdklabs/multi-az-observability.IServiceLatencyMetricDetails": {
|
|
8349
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
8350
|
+
"docs": {
|
|
8351
|
+
"stability": "experimental",
|
|
8352
|
+
"summary": "Details for the defaults used in a service for metrics in one perspective, such as server side latency."
|
|
8353
|
+
},
|
|
8354
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceLatencyMetricDetails",
|
|
8355
|
+
"interfaces": [
|
|
8356
|
+
"@cdklabs/multi-az-observability.IServiceMetricDetails"
|
|
8357
|
+
],
|
|
8358
|
+
"kind": "interface",
|
|
8359
|
+
"locationInModule": {
|
|
8360
|
+
"filename": "src/services/IServiceLatencyMetricDetails.ts",
|
|
8361
|
+
"line": 9
|
|
8362
|
+
},
|
|
8363
|
+
"name": "IServiceLatencyMetricDetails",
|
|
8364
|
+
"properties": [
|
|
7444
8365
|
{
|
|
7445
8366
|
"abstract": true,
|
|
7446
8367
|
"docs": {
|
|
7447
8368
|
"stability": "experimental",
|
|
7448
|
-
"summary": "
|
|
8369
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
7449
8370
|
},
|
|
8371
|
+
"immutable": true,
|
|
7450
8372
|
"locationInModule": {
|
|
7451
|
-
"filename": "src/
|
|
7452
|
-
"line":
|
|
8373
|
+
"filename": "src/services/IServiceLatencyMetricDetails.ts",
|
|
8374
|
+
"line": 14
|
|
7453
8375
|
},
|
|
7454
|
-
"name": "
|
|
7455
|
-
"optional": true,
|
|
8376
|
+
"name": "successAlarmThreshold",
|
|
7456
8377
|
"type": {
|
|
7457
|
-
"fqn": "aws-cdk-lib.
|
|
8378
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
7458
8379
|
}
|
|
7459
8380
|
}
|
|
7460
8381
|
],
|
|
7461
|
-
"symbolId": "src/
|
|
8382
|
+
"symbolId": "src/services/IServiceLatencyMetricDetails:IServiceLatencyMetricDetails"
|
|
7462
8383
|
},
|
|
7463
8384
|
"@cdklabs/multi-az-observability.IServiceMetricDetails": {
|
|
7464
8385
|
"assembly": "@cdklabs/multi-az-observability",
|
|
@@ -7522,22 +8443,6 @@
|
|
|
7522
8443
|
"primitive": "number"
|
|
7523
8444
|
}
|
|
7524
8445
|
},
|
|
7525
|
-
{
|
|
7526
|
-
"abstract": true,
|
|
7527
|
-
"docs": {
|
|
7528
|
-
"stability": "experimental",
|
|
7529
|
-
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
7530
|
-
},
|
|
7531
|
-
"immutable": true,
|
|
7532
|
-
"locationInModule": {
|
|
7533
|
-
"filename": "src/services/IServiceMetricDetails.ts",
|
|
7534
|
-
"line": 81
|
|
7535
|
-
},
|
|
7536
|
-
"name": "faultAlarmThreshold",
|
|
7537
|
-
"type": {
|
|
7538
|
-
"primitive": "number"
|
|
7539
|
-
}
|
|
7540
|
-
},
|
|
7541
8446
|
{
|
|
7542
8447
|
"abstract": true,
|
|
7543
8448
|
"docs": {
|
|
@@ -7591,22 +8496,6 @@
|
|
|
7591
8496
|
"fqn": "aws-cdk-lib.Duration"
|
|
7592
8497
|
}
|
|
7593
8498
|
},
|
|
7594
|
-
{
|
|
7595
|
-
"abstract": true,
|
|
7596
|
-
"docs": {
|
|
7597
|
-
"stability": "experimental",
|
|
7598
|
-
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
7599
|
-
},
|
|
7600
|
-
"immutable": true,
|
|
7601
|
-
"locationInModule": {
|
|
7602
|
-
"filename": "src/services/IServiceMetricDetails.ts",
|
|
7603
|
-
"line": 74
|
|
7604
|
-
},
|
|
7605
|
-
"name": "successAlarmThreshold",
|
|
7606
|
-
"type": {
|
|
7607
|
-
"primitive": "number"
|
|
7608
|
-
}
|
|
7609
|
-
},
|
|
7610
8499
|
{
|
|
7611
8500
|
"abstract": true,
|
|
7612
8501
|
"docs": {
|
|
@@ -7709,7 +8598,7 @@
|
|
|
7709
8598
|
},
|
|
7710
8599
|
"locationInModule": {
|
|
7711
8600
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7712
|
-
"line":
|
|
8601
|
+
"line": 351
|
|
7713
8602
|
},
|
|
7714
8603
|
"parameters": [
|
|
7715
8604
|
{
|
|
@@ -7738,10 +8627,31 @@
|
|
|
7738
8627
|
"kind": "class",
|
|
7739
8628
|
"locationInModule": {
|
|
7740
8629
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7741
|
-
"line":
|
|
8630
|
+
"line": 37
|
|
7742
8631
|
},
|
|
7743
8632
|
"name": "InstrumentedServiceMultiAZObservability",
|
|
7744
8633
|
"properties": [
|
|
8634
|
+
{
|
|
8635
|
+
"docs": {
|
|
8636
|
+
"stability": "experimental",
|
|
8637
|
+
"summary": "Key represents the operation name and the value is the set of zonal alarms and rules for that operation."
|
|
8638
|
+
},
|
|
8639
|
+
"immutable": true,
|
|
8640
|
+
"locationInModule": {
|
|
8641
|
+
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
8642
|
+
"line": 45
|
|
8643
|
+
},
|
|
8644
|
+
"name": "perOperationAlarmsAndRules",
|
|
8645
|
+
"overrides": "@cdklabs/multi-az-observability.IInstrumentedServiceMultiAZObservability",
|
|
8646
|
+
"type": {
|
|
8647
|
+
"collection": {
|
|
8648
|
+
"elementtype": {
|
|
8649
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAlarmsAndRules"
|
|
8650
|
+
},
|
|
8651
|
+
"kind": "map"
|
|
8652
|
+
}
|
|
8653
|
+
}
|
|
8654
|
+
},
|
|
7745
8655
|
{
|
|
7746
8656
|
"docs": {
|
|
7747
8657
|
"remarks": "These are the alarms\nyou would want to use to trigger automation to evacuate an AZ.",
|
|
@@ -7751,7 +8661,7 @@
|
|
|
7751
8661
|
"immutable": true,
|
|
7752
8662
|
"locationInModule": {
|
|
7753
8663
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7754
|
-
"line":
|
|
8664
|
+
"line": 55
|
|
7755
8665
|
},
|
|
7756
8666
|
"name": "perOperationZonalImpactAlarms",
|
|
7757
8667
|
"overrides": "@cdklabs/multi-az-observability.IInstrumentedServiceMultiAZObservability",
|
|
@@ -7777,7 +8687,7 @@
|
|
|
7777
8687
|
"immutable": true,
|
|
7778
8688
|
"locationInModule": {
|
|
7779
8689
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7780
|
-
"line":
|
|
8690
|
+
"line": 62
|
|
7781
8691
|
},
|
|
7782
8692
|
"name": "serviceAlarms",
|
|
7783
8693
|
"overrides": "@cdklabs/multi-az-observability.IInstrumentedServiceMultiAZObservability",
|
|
@@ -7794,7 +8704,7 @@
|
|
|
7794
8704
|
"immutable": true,
|
|
7795
8705
|
"locationInModule": {
|
|
7796
8706
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7797
|
-
"line":
|
|
8707
|
+
"line": 85
|
|
7798
8708
|
},
|
|
7799
8709
|
"name": "canaryLogGroup",
|
|
7800
8710
|
"optional": true,
|
|
@@ -7811,7 +8721,7 @@
|
|
|
7811
8721
|
"immutable": true,
|
|
7812
8722
|
"locationInModule": {
|
|
7813
8723
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7814
|
-
"line":
|
|
8724
|
+
"line": 67
|
|
7815
8725
|
},
|
|
7816
8726
|
"name": "operationDashboards",
|
|
7817
8727
|
"optional": true,
|
|
@@ -7833,7 +8743,7 @@
|
|
|
7833
8743
|
"immutable": true,
|
|
7834
8744
|
"locationInModule": {
|
|
7835
8745
|
"filename": "src/services/InstrumentedServiceMultiAZObservability.ts",
|
|
7836
|
-
"line":
|
|
8746
|
+
"line": 72
|
|
7837
8747
|
},
|
|
7838
8748
|
"name": "serviceDashboard",
|
|
7839
8749
|
"optional": true,
|
|
@@ -8317,7 +9227,7 @@
|
|
|
8317
9227
|
},
|
|
8318
9228
|
"locationInModule": {
|
|
8319
9229
|
"filename": "src/services/Operation.ts",
|
|
8320
|
-
"line":
|
|
9230
|
+
"line": 95
|
|
8321
9231
|
},
|
|
8322
9232
|
"parameters": [
|
|
8323
9233
|
{
|
|
@@ -8334,7 +9244,7 @@
|
|
|
8334
9244
|
"kind": "class",
|
|
8335
9245
|
"locationInModule": {
|
|
8336
9246
|
"filename": "src/services/Operation.ts",
|
|
8337
|
-
"line":
|
|
9247
|
+
"line": 17
|
|
8338
9248
|
},
|
|
8339
9249
|
"name": "Operation",
|
|
8340
9250
|
"properties": [
|
|
@@ -8346,7 +9256,7 @@
|
|
|
8346
9256
|
"immutable": true,
|
|
8347
9257
|
"locationInModule": {
|
|
8348
9258
|
"filename": "src/services/Operation.ts",
|
|
8349
|
-
"line":
|
|
9259
|
+
"line": 73
|
|
8350
9260
|
},
|
|
8351
9261
|
"name": "critical",
|
|
8352
9262
|
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
@@ -8362,7 +9272,7 @@
|
|
|
8362
9272
|
"immutable": true,
|
|
8363
9273
|
"locationInModule": {
|
|
8364
9274
|
"filename": "src/services/Operation.ts",
|
|
8365
|
-
"line":
|
|
9275
|
+
"line": 78
|
|
8366
9276
|
},
|
|
8367
9277
|
"name": "httpMethods",
|
|
8368
9278
|
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
@@ -8383,7 +9293,7 @@
|
|
|
8383
9293
|
"immutable": true,
|
|
8384
9294
|
"locationInModule": {
|
|
8385
9295
|
"filename": "src/services/Operation.ts",
|
|
8386
|
-
"line":
|
|
9296
|
+
"line": 26
|
|
8387
9297
|
},
|
|
8388
9298
|
"name": "operationName",
|
|
8389
9299
|
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
@@ -8399,7 +9309,7 @@
|
|
|
8399
9309
|
"immutable": true,
|
|
8400
9310
|
"locationInModule": {
|
|
8401
9311
|
"filename": "src/services/Operation.ts",
|
|
8402
|
-
"line":
|
|
9312
|
+
"line": 32
|
|
8403
9313
|
},
|
|
8404
9314
|
"name": "path",
|
|
8405
9315
|
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
@@ -8415,12 +9325,12 @@
|
|
|
8415
9325
|
"immutable": true,
|
|
8416
9326
|
"locationInModule": {
|
|
8417
9327
|
"filename": "src/services/Operation.ts",
|
|
8418
|
-
"line":
|
|
9328
|
+
"line": 37
|
|
8419
9329
|
},
|
|
8420
9330
|
"name": "serverSideAvailabilityMetricDetails",
|
|
8421
9331
|
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
8422
9332
|
"type": {
|
|
8423
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
9333
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
8424
9334
|
}
|
|
8425
9335
|
},
|
|
8426
9336
|
{
|
|
@@ -8431,137 +9341,370 @@
|
|
|
8431
9341
|
"immutable": true,
|
|
8432
9342
|
"locationInModule": {
|
|
8433
9343
|
"filename": "src/services/Operation.ts",
|
|
8434
|
-
"line":
|
|
9344
|
+
"line": 42
|
|
8435
9345
|
},
|
|
8436
9346
|
"name": "serverSideLatencyMetricDetails",
|
|
8437
9347
|
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
8438
9348
|
"type": {
|
|
8439
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
9349
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
9350
|
+
}
|
|
9351
|
+
},
|
|
9352
|
+
{
|
|
9353
|
+
"docs": {
|
|
9354
|
+
"stability": "experimental",
|
|
9355
|
+
"summary": "The service the operation is associated with."
|
|
9356
|
+
},
|
|
9357
|
+
"immutable": true,
|
|
9358
|
+
"locationInModule": {
|
|
9359
|
+
"filename": "src/services/Operation.ts",
|
|
9360
|
+
"line": 21
|
|
9361
|
+
},
|
|
9362
|
+
"name": "service",
|
|
9363
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9364
|
+
"type": {
|
|
9365
|
+
"fqn": "@cdklabs/multi-az-observability.IService"
|
|
9366
|
+
}
|
|
9367
|
+
},
|
|
9368
|
+
{
|
|
9369
|
+
"docs": {
|
|
9370
|
+
"stability": "experimental",
|
|
9371
|
+
"summary": "Optional metric details if the service has a canary."
|
|
9372
|
+
},
|
|
9373
|
+
"immutable": true,
|
|
9374
|
+
"locationInModule": {
|
|
9375
|
+
"filename": "src/services/Operation.ts",
|
|
9376
|
+
"line": 47
|
|
9377
|
+
},
|
|
9378
|
+
"name": "canaryMetricDetails",
|
|
9379
|
+
"optional": true,
|
|
9380
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9381
|
+
"type": {
|
|
9382
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryMetrics"
|
|
9383
|
+
}
|
|
9384
|
+
},
|
|
9385
|
+
{
|
|
9386
|
+
"docs": {
|
|
9387
|
+
"stability": "experimental",
|
|
9388
|
+
"summary": "The override values for automatically created canary tests so you can use values other than the service defaults to define the thresholds for availability."
|
|
9389
|
+
},
|
|
9390
|
+
"immutable": true,
|
|
9391
|
+
"locationInModule": {
|
|
9392
|
+
"filename": "src/services/Operation.ts",
|
|
9393
|
+
"line": 54
|
|
9394
|
+
},
|
|
9395
|
+
"name": "canaryTestAvailabilityMetricsOverride",
|
|
9396
|
+
"optional": true,
|
|
9397
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9398
|
+
"type": {
|
|
9399
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestAvailabilityMetricsOverride"
|
|
9400
|
+
}
|
|
9401
|
+
},
|
|
9402
|
+
{
|
|
9403
|
+
"docs": {
|
|
9404
|
+
"stability": "experimental",
|
|
9405
|
+
"summary": "The override values for automatically created canary tests so you can use values other than the service defaults to define the thresholds for latency."
|
|
9406
|
+
},
|
|
9407
|
+
"immutable": true,
|
|
9408
|
+
"locationInModule": {
|
|
9409
|
+
"filename": "src/services/Operation.ts",
|
|
9410
|
+
"line": 61
|
|
9411
|
+
},
|
|
9412
|
+
"name": "canaryTestLatencyMetricsOverride",
|
|
9413
|
+
"optional": true,
|
|
9414
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9415
|
+
"type": {
|
|
9416
|
+
"fqn": "@cdklabs/multi-az-observability.ICanaryTestLatencyMetricsOverride"
|
|
9417
|
+
}
|
|
9418
|
+
},
|
|
9419
|
+
{
|
|
9420
|
+
"docs": {
|
|
9421
|
+
"stability": "experimental",
|
|
9422
|
+
"summary": "If they have been added, the properties for creating new canary tests on this operation."
|
|
9423
|
+
},
|
|
9424
|
+
"immutable": true,
|
|
9425
|
+
"locationInModule": {
|
|
9426
|
+
"filename": "src/services/Operation.ts",
|
|
9427
|
+
"line": 84
|
|
9428
|
+
},
|
|
9429
|
+
"name": "canaryTestProps",
|
|
9430
|
+
"optional": true,
|
|
9431
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9432
|
+
"type": {
|
|
9433
|
+
"fqn": "@cdklabs/multi-az-observability.AddCanaryTestProps"
|
|
9434
|
+
}
|
|
9435
|
+
},
|
|
9436
|
+
{
|
|
9437
|
+
"docs": {
|
|
9438
|
+
"default": "- The operation is not opted out",
|
|
9439
|
+
"stability": "experimental",
|
|
9440
|
+
"summary": "Set to true if you have defined CanaryTestProps for your service, which applies to all operations, but you want to opt out of creating the canary test for this operation."
|
|
9441
|
+
},
|
|
9442
|
+
"immutable": true,
|
|
9443
|
+
"locationInModule": {
|
|
9444
|
+
"filename": "src/services/Operation.ts",
|
|
9445
|
+
"line": 93
|
|
9446
|
+
},
|
|
9447
|
+
"name": "optOutOfServiceCreatedCanary",
|
|
9448
|
+
"optional": true,
|
|
9449
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9450
|
+
"type": {
|
|
9451
|
+
"primitive": "boolean"
|
|
9452
|
+
}
|
|
9453
|
+
},
|
|
9454
|
+
{
|
|
9455
|
+
"docs": {
|
|
9456
|
+
"stability": "experimental",
|
|
9457
|
+
"summary": "The server side details for contributor insights rules."
|
|
9458
|
+
},
|
|
9459
|
+
"immutable": true,
|
|
9460
|
+
"locationInModule": {
|
|
9461
|
+
"filename": "src/services/Operation.ts",
|
|
9462
|
+
"line": 66
|
|
9463
|
+
},
|
|
9464
|
+
"name": "serverSideContributorInsightRuleDetails",
|
|
9465
|
+
"optional": true,
|
|
9466
|
+
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9467
|
+
"type": {
|
|
9468
|
+
"fqn": "@cdklabs/multi-az-observability.IContributorInsightRuleDetails"
|
|
9469
|
+
}
|
|
9470
|
+
}
|
|
9471
|
+
],
|
|
9472
|
+
"symbolId": "src/services/Operation:Operation"
|
|
9473
|
+
},
|
|
9474
|
+
"@cdklabs/multi-az-observability.OperationAvailabilityMetricDetails": {
|
|
9475
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
9476
|
+
"base": "@cdklabs/multi-az-observability.OperationMetricDetails",
|
|
9477
|
+
"docs": {
|
|
9478
|
+
"stability": "experimental",
|
|
9479
|
+
"summary": "Availability metric details for an operation."
|
|
9480
|
+
},
|
|
9481
|
+
"fqn": "@cdklabs/multi-az-observability.OperationAvailabilityMetricDetails",
|
|
9482
|
+
"initializer": {
|
|
9483
|
+
"docs": {
|
|
9484
|
+
"stability": "experimental"
|
|
9485
|
+
},
|
|
9486
|
+
"locationInModule": {
|
|
9487
|
+
"filename": "src/services/OperationAvailabilityMetricDetails.ts",
|
|
9488
|
+
"line": 27
|
|
9489
|
+
},
|
|
9490
|
+
"parameters": [
|
|
9491
|
+
{
|
|
9492
|
+
"name": "props",
|
|
9493
|
+
"type": {
|
|
9494
|
+
"fqn": "@cdklabs/multi-az-observability.OperationAvailabilityMetricDetailsProps"
|
|
9495
|
+
}
|
|
9496
|
+
},
|
|
9497
|
+
{
|
|
9498
|
+
"name": "defaultProps",
|
|
9499
|
+
"type": {
|
|
9500
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails"
|
|
9501
|
+
}
|
|
8440
9502
|
}
|
|
8441
|
-
|
|
9503
|
+
]
|
|
9504
|
+
},
|
|
9505
|
+
"interfaces": [
|
|
9506
|
+
"@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
9507
|
+
],
|
|
9508
|
+
"kind": "class",
|
|
9509
|
+
"locationInModule": {
|
|
9510
|
+
"filename": "src/services/OperationAvailabilityMetricDetails.ts",
|
|
9511
|
+
"line": 11
|
|
9512
|
+
},
|
|
9513
|
+
"name": "OperationAvailabilityMetricDetails",
|
|
9514
|
+
"properties": [
|
|
8442
9515
|
{
|
|
8443
9516
|
"docs": {
|
|
8444
9517
|
"stability": "experimental",
|
|
8445
|
-
"summary": "The
|
|
9518
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
8446
9519
|
},
|
|
8447
9520
|
"immutable": true,
|
|
8448
9521
|
"locationInModule": {
|
|
8449
|
-
"filename": "src/services/
|
|
8450
|
-
"line":
|
|
9522
|
+
"filename": "src/services/OperationAvailabilityMetricDetails.ts",
|
|
9523
|
+
"line": 25
|
|
8451
9524
|
},
|
|
8452
|
-
"name": "
|
|
8453
|
-
"overrides": "@cdklabs/multi-az-observability.
|
|
9525
|
+
"name": "faultAlarmThreshold",
|
|
9526
|
+
"overrides": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails",
|
|
8454
9527
|
"type": {
|
|
8455
|
-
"
|
|
9528
|
+
"primitive": "number"
|
|
8456
9529
|
}
|
|
8457
9530
|
},
|
|
8458
9531
|
{
|
|
8459
9532
|
"docs": {
|
|
8460
9533
|
"stability": "experimental",
|
|
8461
|
-
"summary": "
|
|
9534
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
8462
9535
|
},
|
|
8463
9536
|
"immutable": true,
|
|
8464
9537
|
"locationInModule": {
|
|
8465
|
-
"filename": "src/services/
|
|
8466
|
-
"line":
|
|
9538
|
+
"filename": "src/services/OperationAvailabilityMetricDetails.ts",
|
|
9539
|
+
"line": 18
|
|
8467
9540
|
},
|
|
8468
|
-
"name": "
|
|
8469
|
-
"
|
|
8470
|
-
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9541
|
+
"name": "successAlarmThreshold",
|
|
9542
|
+
"overrides": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails",
|
|
8471
9543
|
"type": {
|
|
8472
|
-
"
|
|
9544
|
+
"primitive": "number"
|
|
8473
9545
|
}
|
|
8474
|
-
}
|
|
9546
|
+
}
|
|
9547
|
+
],
|
|
9548
|
+
"symbolId": "src/services/OperationAvailabilityMetricDetails:OperationAvailabilityMetricDetails"
|
|
9549
|
+
},
|
|
9550
|
+
"@cdklabs/multi-az-observability.OperationAvailabilityMetricDetailsProps": {
|
|
9551
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
9552
|
+
"datatype": true,
|
|
9553
|
+
"docs": {
|
|
9554
|
+
"stability": "experimental",
|
|
9555
|
+
"summary": "The properties for an operation's availability metric details."
|
|
9556
|
+
},
|
|
9557
|
+
"fqn": "@cdklabs/multi-az-observability.OperationAvailabilityMetricDetailsProps",
|
|
9558
|
+
"interfaces": [
|
|
9559
|
+
"@cdklabs/multi-az-observability.OperationMetricDetailsProps"
|
|
9560
|
+
],
|
|
9561
|
+
"kind": "interface",
|
|
9562
|
+
"locationInModule": {
|
|
9563
|
+
"filename": "src/services/props/OperationAvailabilityMetricDetailsProps.ts",
|
|
9564
|
+
"line": 8
|
|
9565
|
+
},
|
|
9566
|
+
"name": "OperationAvailabilityMetricDetailsProps",
|
|
9567
|
+
"properties": [
|
|
8475
9568
|
{
|
|
9569
|
+
"abstract": true,
|
|
8476
9570
|
"docs": {
|
|
9571
|
+
"default": "- The service default is used",
|
|
8477
9572
|
"stability": "experimental",
|
|
8478
|
-
"summary": "The
|
|
9573
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
8479
9574
|
},
|
|
8480
9575
|
"immutable": true,
|
|
8481
9576
|
"locationInModule": {
|
|
8482
|
-
"filename": "src/services/
|
|
8483
|
-
"line":
|
|
9577
|
+
"filename": "src/services/props/OperationAvailabilityMetricDetailsProps.ts",
|
|
9578
|
+
"line": 26
|
|
8484
9579
|
},
|
|
8485
|
-
"name": "
|
|
9580
|
+
"name": "faultAlarmThreshold",
|
|
8486
9581
|
"optional": true,
|
|
8487
|
-
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
8488
9582
|
"type": {
|
|
8489
|
-
"
|
|
9583
|
+
"primitive": "number"
|
|
8490
9584
|
}
|
|
8491
9585
|
},
|
|
8492
9586
|
{
|
|
9587
|
+
"abstract": true,
|
|
8493
9588
|
"docs": {
|
|
9589
|
+
"default": "- The service default is used",
|
|
8494
9590
|
"stability": "experimental",
|
|
8495
|
-
"summary": "The
|
|
9591
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
8496
9592
|
},
|
|
8497
9593
|
"immutable": true,
|
|
8498
9594
|
"locationInModule": {
|
|
8499
|
-
"filename": "src/services/
|
|
8500
|
-
"line":
|
|
9595
|
+
"filename": "src/services/props/OperationAvailabilityMetricDetailsProps.ts",
|
|
9596
|
+
"line": 17
|
|
8501
9597
|
},
|
|
8502
|
-
"name": "
|
|
9598
|
+
"name": "successAlarmThreshold",
|
|
8503
9599
|
"optional": true,
|
|
8504
|
-
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
8505
9600
|
"type": {
|
|
8506
|
-
"
|
|
9601
|
+
"primitive": "number"
|
|
8507
9602
|
}
|
|
9603
|
+
}
|
|
9604
|
+
],
|
|
9605
|
+
"symbolId": "src/services/props/OperationAvailabilityMetricDetailsProps:OperationAvailabilityMetricDetailsProps"
|
|
9606
|
+
},
|
|
9607
|
+
"@cdklabs/multi-az-observability.OperationLatencyMetricDetails": {
|
|
9608
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
9609
|
+
"base": "@cdklabs/multi-az-observability.OperationMetricDetails",
|
|
9610
|
+
"docs": {
|
|
9611
|
+
"stability": "experimental",
|
|
9612
|
+
"summary": "Latency metric details for an operation."
|
|
9613
|
+
},
|
|
9614
|
+
"fqn": "@cdklabs/multi-az-observability.OperationLatencyMetricDetails",
|
|
9615
|
+
"initializer": {
|
|
9616
|
+
"docs": {
|
|
9617
|
+
"stability": "experimental"
|
|
8508
9618
|
},
|
|
8509
|
-
{
|
|
8510
|
-
"
|
|
8511
|
-
|
|
8512
|
-
|
|
8513
|
-
|
|
8514
|
-
|
|
8515
|
-
|
|
8516
|
-
"
|
|
8517
|
-
|
|
9619
|
+
"locationInModule": {
|
|
9620
|
+
"filename": "src/services/OperationLatencyMetricDetails.ts",
|
|
9621
|
+
"line": 20
|
|
9622
|
+
},
|
|
9623
|
+
"parameters": [
|
|
9624
|
+
{
|
|
9625
|
+
"name": "props",
|
|
9626
|
+
"type": {
|
|
9627
|
+
"fqn": "@cdklabs/multi-az-observability.OperationLatencyMetricDetailsProps"
|
|
9628
|
+
}
|
|
8518
9629
|
},
|
|
8519
|
-
|
|
8520
|
-
|
|
8521
|
-
|
|
8522
|
-
|
|
8523
|
-
|
|
9630
|
+
{
|
|
9631
|
+
"name": "defaultProps",
|
|
9632
|
+
"type": {
|
|
9633
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceLatencyMetricDetails"
|
|
9634
|
+
}
|
|
8524
9635
|
}
|
|
8525
|
-
|
|
9636
|
+
]
|
|
9637
|
+
},
|
|
9638
|
+
"interfaces": [
|
|
9639
|
+
"@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
9640
|
+
],
|
|
9641
|
+
"kind": "class",
|
|
9642
|
+
"locationInModule": {
|
|
9643
|
+
"filename": "src/services/OperationLatencyMetricDetails.ts",
|
|
9644
|
+
"line": 12
|
|
9645
|
+
},
|
|
9646
|
+
"name": "OperationLatencyMetricDetails",
|
|
9647
|
+
"properties": [
|
|
8526
9648
|
{
|
|
8527
9649
|
"docs": {
|
|
8528
|
-
"default": "- The operation is not opted out",
|
|
8529
9650
|
"stability": "experimental",
|
|
8530
|
-
"summary": "
|
|
9651
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
8531
9652
|
},
|
|
8532
9653
|
"immutable": true,
|
|
8533
9654
|
"locationInModule": {
|
|
8534
|
-
"filename": "src/services/
|
|
8535
|
-
"line":
|
|
9655
|
+
"filename": "src/services/OperationLatencyMetricDetails.ts",
|
|
9656
|
+
"line": 18
|
|
8536
9657
|
},
|
|
8537
|
-
"name": "
|
|
8538
|
-
"
|
|
8539
|
-
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
9658
|
+
"name": "successAlarmThreshold",
|
|
9659
|
+
"overrides": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails",
|
|
8540
9660
|
"type": {
|
|
8541
|
-
"
|
|
9661
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
8542
9662
|
}
|
|
8543
|
-
}
|
|
9663
|
+
}
|
|
9664
|
+
],
|
|
9665
|
+
"symbolId": "src/services/OperationLatencyMetricDetails:OperationLatencyMetricDetails"
|
|
9666
|
+
},
|
|
9667
|
+
"@cdklabs/multi-az-observability.OperationLatencyMetricDetailsProps": {
|
|
9668
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
9669
|
+
"datatype": true,
|
|
9670
|
+
"docs": {
|
|
9671
|
+
"stability": "experimental",
|
|
9672
|
+
"summary": "The properties for an operation's latency metric details."
|
|
9673
|
+
},
|
|
9674
|
+
"fqn": "@cdklabs/multi-az-observability.OperationLatencyMetricDetailsProps",
|
|
9675
|
+
"interfaces": [
|
|
9676
|
+
"@cdklabs/multi-az-observability.OperationMetricDetailsProps"
|
|
9677
|
+
],
|
|
9678
|
+
"kind": "interface",
|
|
9679
|
+
"locationInModule": {
|
|
9680
|
+
"filename": "src/services/props/OperationLatencyMetricDetailsProps.ts",
|
|
9681
|
+
"line": 9
|
|
9682
|
+
},
|
|
9683
|
+
"name": "OperationLatencyMetricDetailsProps",
|
|
9684
|
+
"properties": [
|
|
8544
9685
|
{
|
|
9686
|
+
"abstract": true,
|
|
8545
9687
|
"docs": {
|
|
9688
|
+
"default": "\"The service default is used\"",
|
|
8546
9689
|
"stability": "experimental",
|
|
8547
|
-
"summary": "The
|
|
9690
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
8548
9691
|
},
|
|
8549
9692
|
"immutable": true,
|
|
8550
9693
|
"locationInModule": {
|
|
8551
|
-
"filename": "src/services/
|
|
8552
|
-
"line":
|
|
9694
|
+
"filename": "src/services/props/OperationLatencyMetricDetailsProps.ts",
|
|
9695
|
+
"line": 16
|
|
8553
9696
|
},
|
|
8554
|
-
"name": "
|
|
9697
|
+
"name": "successAlarmThreshold",
|
|
8555
9698
|
"optional": true,
|
|
8556
|
-
"overrides": "@cdklabs/multi-az-observability.IOperation",
|
|
8557
9699
|
"type": {
|
|
8558
|
-
"fqn": "
|
|
9700
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
8559
9701
|
}
|
|
8560
9702
|
}
|
|
8561
9703
|
],
|
|
8562
|
-
"symbolId": "src/services/
|
|
9704
|
+
"symbolId": "src/services/props/OperationLatencyMetricDetailsProps:OperationLatencyMetricDetailsProps"
|
|
8563
9705
|
},
|
|
8564
9706
|
"@cdklabs/multi-az-observability.OperationMetricDetails": {
|
|
9707
|
+
"abstract": true,
|
|
8565
9708
|
"assembly": "@cdklabs/multi-az-observability",
|
|
8566
9709
|
"docs": {
|
|
8567
9710
|
"stability": "experimental",
|
|
@@ -8574,7 +9717,7 @@
|
|
|
8574
9717
|
},
|
|
8575
9718
|
"locationInModule": {
|
|
8576
9719
|
"filename": "src/services/OperationMetricDetails.ts",
|
|
8577
|
-
"line":
|
|
9720
|
+
"line": 84
|
|
8578
9721
|
},
|
|
8579
9722
|
"parameters": [
|
|
8580
9723
|
{
|
|
@@ -8649,22 +9792,6 @@
|
|
|
8649
9792
|
"primitive": "number"
|
|
8650
9793
|
}
|
|
8651
9794
|
},
|
|
8652
|
-
{
|
|
8653
|
-
"docs": {
|
|
8654
|
-
"stability": "experimental",
|
|
8655
|
-
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
8656
|
-
},
|
|
8657
|
-
"immutable": true,
|
|
8658
|
-
"locationInModule": {
|
|
8659
|
-
"filename": "src/services/OperationMetricDetails.ts",
|
|
8660
|
-
"line": 90
|
|
8661
|
-
},
|
|
8662
|
-
"name": "faultAlarmThreshold",
|
|
8663
|
-
"overrides": "@cdklabs/multi-az-observability.IOperationMetricDetails",
|
|
8664
|
-
"type": {
|
|
8665
|
-
"primitive": "number"
|
|
8666
|
-
}
|
|
8667
|
-
},
|
|
8668
9795
|
{
|
|
8669
9796
|
"docs": {
|
|
8670
9797
|
"stability": "experimental",
|
|
@@ -8694,7 +9821,7 @@
|
|
|
8694
9821
|
"immutable": true,
|
|
8695
9822
|
"locationInModule": {
|
|
8696
9823
|
"filename": "src/services/OperationMetricDetails.ts",
|
|
8697
|
-
"line":
|
|
9824
|
+
"line": 82
|
|
8698
9825
|
},
|
|
8699
9826
|
"name": "metricDimensions",
|
|
8700
9827
|
"overrides": "@cdklabs/multi-az-observability.IOperationMetricDetails",
|
|
@@ -8750,22 +9877,6 @@
|
|
|
8750
9877
|
"fqn": "aws-cdk-lib.Duration"
|
|
8751
9878
|
}
|
|
8752
9879
|
},
|
|
8753
|
-
{
|
|
8754
|
-
"docs": {
|
|
8755
|
-
"stability": "experimental",
|
|
8756
|
-
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
8757
|
-
},
|
|
8758
|
-
"immutable": true,
|
|
8759
|
-
"locationInModule": {
|
|
8760
|
-
"filename": "src/services/OperationMetricDetails.ts",
|
|
8761
|
-
"line": 83
|
|
8762
|
-
},
|
|
8763
|
-
"name": "successAlarmThreshold",
|
|
8764
|
-
"overrides": "@cdklabs/multi-az-observability.IOperationMetricDetails",
|
|
8765
|
-
"type": {
|
|
8766
|
-
"primitive": "number"
|
|
8767
|
-
}
|
|
8768
|
-
},
|
|
8769
9880
|
{
|
|
8770
9881
|
"docs": {
|
|
8771
9882
|
"stability": "experimental",
|
|
@@ -8878,7 +9989,7 @@
|
|
|
8878
9989
|
"immutable": true,
|
|
8879
9990
|
"locationInModule": {
|
|
8880
9991
|
"filename": "src/services/props/OperationMetricDetailsProps.ts",
|
|
8881
|
-
"line":
|
|
9992
|
+
"line": 94
|
|
8882
9993
|
},
|
|
8883
9994
|
"name": "metricDimensions",
|
|
8884
9995
|
"type": {
|
|
@@ -8955,24 +10066,6 @@
|
|
|
8955
10066
|
"primitive": "number"
|
|
8956
10067
|
}
|
|
8957
10068
|
},
|
|
8958
|
-
{
|
|
8959
|
-
"abstract": true,
|
|
8960
|
-
"docs": {
|
|
8961
|
-
"default": "- The service default is used",
|
|
8962
|
-
"stability": "experimental",
|
|
8963
|
-
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
8964
|
-
},
|
|
8965
|
-
"immutable": true,
|
|
8966
|
-
"locationInModule": {
|
|
8967
|
-
"filename": "src/services/props/OperationMetricDetailsProps.ts",
|
|
8968
|
-
"line": 107
|
|
8969
|
-
},
|
|
8970
|
-
"name": "faultAlarmThreshold",
|
|
8971
|
-
"optional": true,
|
|
8972
|
-
"type": {
|
|
8973
|
-
"primitive": "number"
|
|
8974
|
-
}
|
|
8975
|
-
},
|
|
8976
10069
|
{
|
|
8977
10070
|
"abstract": true,
|
|
8978
10071
|
"docs": {
|
|
@@ -9080,24 +10173,6 @@
|
|
|
9080
10173
|
"fqn": "aws-cdk-lib.Duration"
|
|
9081
10174
|
}
|
|
9082
10175
|
},
|
|
9083
|
-
{
|
|
9084
|
-
"abstract": true,
|
|
9085
|
-
"docs": {
|
|
9086
|
-
"default": "- The service default is used",
|
|
9087
|
-
"stability": "experimental",
|
|
9088
|
-
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
9089
|
-
},
|
|
9090
|
-
"immutable": true,
|
|
9091
|
-
"locationInModule": {
|
|
9092
|
-
"filename": "src/services/props/OperationMetricDetailsProps.ts",
|
|
9093
|
-
"line": 98
|
|
9094
|
-
},
|
|
9095
|
-
"name": "successAlarmThreshold",
|
|
9096
|
-
"optional": true,
|
|
9097
|
-
"type": {
|
|
9098
|
-
"primitive": "number"
|
|
9099
|
-
}
|
|
9100
|
-
},
|
|
9101
10176
|
{
|
|
9102
10177
|
"abstract": true,
|
|
9103
10178
|
"docs": {
|
|
@@ -9153,7 +10228,7 @@
|
|
|
9153
10228
|
"kind": "interface",
|
|
9154
10229
|
"locationInModule": {
|
|
9155
10230
|
"filename": "src/services/props/OperationProps.ts",
|
|
9156
|
-
"line":
|
|
10231
|
+
"line": 14
|
|
9157
10232
|
},
|
|
9158
10233
|
"name": "OperationProps",
|
|
9159
10234
|
"properties": [
|
|
@@ -9166,7 +10241,7 @@
|
|
|
9166
10241
|
"immutable": true,
|
|
9167
10242
|
"locationInModule": {
|
|
9168
10243
|
"filename": "src/services/props/OperationProps.ts",
|
|
9169
|
-
"line":
|
|
10244
|
+
"line": 85
|
|
9170
10245
|
},
|
|
9171
10246
|
"name": "critical",
|
|
9172
10247
|
"type": {
|
|
@@ -9182,7 +10257,7 @@
|
|
|
9182
10257
|
"immutable": true,
|
|
9183
10258
|
"locationInModule": {
|
|
9184
10259
|
"filename": "src/services/props/OperationProps.ts",
|
|
9185
|
-
"line":
|
|
10260
|
+
"line": 108
|
|
9186
10261
|
},
|
|
9187
10262
|
"name": "httpMethods",
|
|
9188
10263
|
"type": {
|
|
@@ -9203,7 +10278,7 @@
|
|
|
9203
10278
|
"immutable": true,
|
|
9204
10279
|
"locationInModule": {
|
|
9205
10280
|
"filename": "src/services/props/OperationProps.ts",
|
|
9206
|
-
"line":
|
|
10281
|
+
"line": 23
|
|
9207
10282
|
},
|
|
9208
10283
|
"name": "operationName",
|
|
9209
10284
|
"type": {
|
|
@@ -9219,7 +10294,7 @@
|
|
|
9219
10294
|
"immutable": true,
|
|
9220
10295
|
"locationInModule": {
|
|
9221
10296
|
"filename": "src/services/props/OperationProps.ts",
|
|
9222
|
-
"line":
|
|
10297
|
+
"line": 29
|
|
9223
10298
|
},
|
|
9224
10299
|
"name": "path",
|
|
9225
10300
|
"type": {
|
|
@@ -9235,11 +10310,11 @@
|
|
|
9235
10310
|
"immutable": true,
|
|
9236
10311
|
"locationInModule": {
|
|
9237
10312
|
"filename": "src/services/props/OperationProps.ts",
|
|
9238
|
-
"line":
|
|
10313
|
+
"line": 34
|
|
9239
10314
|
},
|
|
9240
10315
|
"name": "serverSideAvailabilityMetricDetails",
|
|
9241
10316
|
"type": {
|
|
9242
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
10317
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationAvailabilityMetricDetails"
|
|
9243
10318
|
}
|
|
9244
10319
|
},
|
|
9245
10320
|
{
|
|
@@ -9251,11 +10326,11 @@
|
|
|
9251
10326
|
"immutable": true,
|
|
9252
10327
|
"locationInModule": {
|
|
9253
10328
|
"filename": "src/services/props/OperationProps.ts",
|
|
9254
|
-
"line":
|
|
10329
|
+
"line": 39
|
|
9255
10330
|
},
|
|
9256
10331
|
"name": "serverSideLatencyMetricDetails",
|
|
9257
10332
|
"type": {
|
|
9258
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
10333
|
+
"fqn": "@cdklabs/multi-az-observability.IOperationLatencyMetricDetails"
|
|
9259
10334
|
}
|
|
9260
10335
|
},
|
|
9261
10336
|
{
|
|
@@ -9267,7 +10342,7 @@
|
|
|
9267
10342
|
"immutable": true,
|
|
9268
10343
|
"locationInModule": {
|
|
9269
10344
|
"filename": "src/services/props/OperationProps.ts",
|
|
9270
|
-
"line":
|
|
10345
|
+
"line": 18
|
|
9271
10346
|
},
|
|
9272
10347
|
"name": "service",
|
|
9273
10348
|
"type": {
|
|
@@ -9284,7 +10359,7 @@
|
|
|
9284
10359
|
"immutable": true,
|
|
9285
10360
|
"locationInModule": {
|
|
9286
10361
|
"filename": "src/services/props/OperationProps.ts",
|
|
9287
|
-
"line":
|
|
10362
|
+
"line": 47
|
|
9288
10363
|
},
|
|
9289
10364
|
"name": "canaryMetricDetails",
|
|
9290
10365
|
"optional": true,
|
|
@@ -9302,7 +10377,7 @@
|
|
|
9302
10377
|
"immutable": true,
|
|
9303
10378
|
"locationInModule": {
|
|
9304
10379
|
"filename": "src/services/props/OperationProps.ts",
|
|
9305
|
-
"line":
|
|
10380
|
+
"line": 57
|
|
9306
10381
|
},
|
|
9307
10382
|
"name": "canaryTestAvailabilityMetricsOverride",
|
|
9308
10383
|
"optional": true,
|
|
@@ -9320,7 +10395,7 @@
|
|
|
9320
10395
|
"immutable": true,
|
|
9321
10396
|
"locationInModule": {
|
|
9322
10397
|
"filename": "src/services/props/OperationProps.ts",
|
|
9323
|
-
"line":
|
|
10398
|
+
"line": 67
|
|
9324
10399
|
},
|
|
9325
10400
|
"name": "canaryTestLatencyMetricsOverride",
|
|
9326
10401
|
"optional": true,
|
|
@@ -9338,7 +10413,7 @@
|
|
|
9338
10413
|
"immutable": true,
|
|
9339
10414
|
"locationInModule": {
|
|
9340
10415
|
"filename": "src/services/props/OperationProps.ts",
|
|
9341
|
-
"line":
|
|
10416
|
+
"line": 94
|
|
9342
10417
|
},
|
|
9343
10418
|
"name": "canaryTestProps",
|
|
9344
10419
|
"optional": true,
|
|
@@ -9356,7 +10431,7 @@
|
|
|
9356
10431
|
"immutable": true,
|
|
9357
10432
|
"locationInModule": {
|
|
9358
10433
|
"filename": "src/services/props/OperationProps.ts",
|
|
9359
|
-
"line":
|
|
10434
|
+
"line": 103
|
|
9360
10435
|
},
|
|
9361
10436
|
"name": "optOutOfServiceCreatedCanary",
|
|
9362
10437
|
"optional": true,
|
|
@@ -9374,7 +10449,7 @@
|
|
|
9374
10449
|
"immutable": true,
|
|
9375
10450
|
"locationInModule": {
|
|
9376
10451
|
"filename": "src/services/props/OperationProps.ts",
|
|
9377
|
-
"line":
|
|
10452
|
+
"line": 78
|
|
9378
10453
|
},
|
|
9379
10454
|
"name": "serverSideContributorInsightRuleDetails",
|
|
9380
10455
|
"optional": true,
|
|
@@ -9479,7 +10554,7 @@
|
|
|
9479
10554
|
},
|
|
9480
10555
|
"locationInModule": {
|
|
9481
10556
|
"filename": "src/services/Service.ts",
|
|
9482
|
-
"line":
|
|
10557
|
+
"line": 89
|
|
9483
10558
|
},
|
|
9484
10559
|
"parameters": [
|
|
9485
10560
|
{
|
|
@@ -9496,7 +10571,7 @@
|
|
|
9496
10571
|
"kind": "class",
|
|
9497
10572
|
"locationInModule": {
|
|
9498
10573
|
"filename": "src/services/Service.ts",
|
|
9499
|
-
"line":
|
|
10574
|
+
"line": 16
|
|
9500
10575
|
},
|
|
9501
10576
|
"methods": [
|
|
9502
10577
|
{
|
|
@@ -9506,7 +10581,7 @@
|
|
|
9506
10581
|
},
|
|
9507
10582
|
"locationInModule": {
|
|
9508
10583
|
"filename": "src/services/Service.ts",
|
|
9509
|
-
"line":
|
|
10584
|
+
"line": 109
|
|
9510
10585
|
},
|
|
9511
10586
|
"name": "addOperation",
|
|
9512
10587
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9530,7 +10605,7 @@
|
|
|
9530
10605
|
"immutable": true,
|
|
9531
10606
|
"locationInModule": {
|
|
9532
10607
|
"filename": "src/services/Service.ts",
|
|
9533
|
-
"line":
|
|
10608
|
+
"line": 36
|
|
9534
10609
|
},
|
|
9535
10610
|
"name": "availabilityZoneNames",
|
|
9536
10611
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9551,7 +10626,7 @@
|
|
|
9551
10626
|
"immutable": true,
|
|
9552
10627
|
"locationInModule": {
|
|
9553
10628
|
"filename": "src/services/Service.ts",
|
|
9554
|
-
"line":
|
|
10629
|
+
"line": 25
|
|
9555
10630
|
},
|
|
9556
10631
|
"name": "baseUrl",
|
|
9557
10632
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9567,12 +10642,12 @@
|
|
|
9567
10642
|
"immutable": true,
|
|
9568
10643
|
"locationInModule": {
|
|
9569
10644
|
"filename": "src/services/Service.ts",
|
|
9570
|
-
"line":
|
|
10645
|
+
"line": 72
|
|
9571
10646
|
},
|
|
9572
10647
|
"name": "defaultAvailabilityMetricDetails",
|
|
9573
10648
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
9574
10649
|
"type": {
|
|
9575
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
10650
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails"
|
|
9576
10651
|
}
|
|
9577
10652
|
},
|
|
9578
10653
|
{
|
|
@@ -9583,12 +10658,12 @@
|
|
|
9583
10658
|
"immutable": true,
|
|
9584
10659
|
"locationInModule": {
|
|
9585
10660
|
"filename": "src/services/Service.ts",
|
|
9586
|
-
"line":
|
|
10661
|
+
"line": 79
|
|
9587
10662
|
},
|
|
9588
10663
|
"name": "defaultLatencyMetricDetails",
|
|
9589
10664
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
9590
10665
|
"type": {
|
|
9591
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
10666
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceLatencyMetricDetails"
|
|
9592
10667
|
}
|
|
9593
10668
|
},
|
|
9594
10669
|
{
|
|
@@ -9600,7 +10675,7 @@
|
|
|
9600
10675
|
"immutable": true,
|
|
9601
10676
|
"locationInModule": {
|
|
9602
10677
|
"filename": "src/services/Service.ts",
|
|
9603
|
-
"line":
|
|
10678
|
+
"line": 31
|
|
9604
10679
|
},
|
|
9605
10680
|
"name": "faultCountThreshold",
|
|
9606
10681
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9616,7 +10691,7 @@
|
|
|
9616
10691
|
"immutable": true,
|
|
9617
10692
|
"locationInModule": {
|
|
9618
10693
|
"filename": "src/services/Service.ts",
|
|
9619
|
-
"line":
|
|
10694
|
+
"line": 46
|
|
9620
10695
|
},
|
|
9621
10696
|
"name": "operations",
|
|
9622
10697
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9637,7 +10712,7 @@
|
|
|
9637
10712
|
"immutable": true,
|
|
9638
10713
|
"locationInModule": {
|
|
9639
10714
|
"filename": "src/services/Service.ts",
|
|
9640
|
-
"line":
|
|
10715
|
+
"line": 41
|
|
9641
10716
|
},
|
|
9642
10717
|
"name": "period",
|
|
9643
10718
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9653,7 +10728,7 @@
|
|
|
9653
10728
|
"immutable": true,
|
|
9654
10729
|
"locationInModule": {
|
|
9655
10730
|
"filename": "src/services/Service.ts",
|
|
9656
|
-
"line":
|
|
10731
|
+
"line": 20
|
|
9657
10732
|
},
|
|
9658
10733
|
"name": "serviceName",
|
|
9659
10734
|
"overrides": "@cdklabs/multi-az-observability.IService",
|
|
@@ -9671,7 +10746,7 @@
|
|
|
9671
10746
|
"immutable": true,
|
|
9672
10747
|
"locationInModule": {
|
|
9673
10748
|
"filename": "src/services/Service.ts",
|
|
9674
|
-
"line":
|
|
10749
|
+
"line": 65
|
|
9675
10750
|
},
|
|
9676
10751
|
"name": "canaryTestProps",
|
|
9677
10752
|
"optional": true,
|
|
@@ -9689,7 +10764,7 @@
|
|
|
9689
10764
|
"immutable": true,
|
|
9690
10765
|
"locationInModule": {
|
|
9691
10766
|
"filename": "src/services/Service.ts",
|
|
9692
|
-
"line":
|
|
10767
|
+
"line": 87
|
|
9693
10768
|
},
|
|
9694
10769
|
"name": "defaultContributorInsightRuleDetails",
|
|
9695
10770
|
"optional": true,
|
|
@@ -9707,7 +10782,7 @@
|
|
|
9707
10782
|
"immutable": true,
|
|
9708
10783
|
"locationInModule": {
|
|
9709
10784
|
"filename": "src/services/Service.ts",
|
|
9710
|
-
"line":
|
|
10785
|
+
"line": 55
|
|
9711
10786
|
},
|
|
9712
10787
|
"name": "loadBalancer",
|
|
9713
10788
|
"optional": true,
|
|
@@ -9719,7 +10794,222 @@
|
|
|
9719
10794
|
],
|
|
9720
10795
|
"symbolId": "src/services/Service:Service"
|
|
9721
10796
|
},
|
|
10797
|
+
"@cdklabs/multi-az-observability.ServiceAvailabilityMetricDetails": {
|
|
10798
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
10799
|
+
"base": "@cdklabs/multi-az-observability.ServiceMetricDetails",
|
|
10800
|
+
"docs": {
|
|
10801
|
+
"stability": "experimental",
|
|
10802
|
+
"summary": "Default availability metric details for a service."
|
|
10803
|
+
},
|
|
10804
|
+
"fqn": "@cdklabs/multi-az-observability.ServiceAvailabilityMetricDetails",
|
|
10805
|
+
"initializer": {
|
|
10806
|
+
"docs": {
|
|
10807
|
+
"stability": "experimental"
|
|
10808
|
+
},
|
|
10809
|
+
"locationInModule": {
|
|
10810
|
+
"filename": "src/services/ServiceAvailabilityMetricDetails.ts",
|
|
10811
|
+
"line": 25
|
|
10812
|
+
},
|
|
10813
|
+
"parameters": [
|
|
10814
|
+
{
|
|
10815
|
+
"name": "props",
|
|
10816
|
+
"type": {
|
|
10817
|
+
"fqn": "@cdklabs/multi-az-observability.ServiceAvailabilityMetricDetailsProps"
|
|
10818
|
+
}
|
|
10819
|
+
}
|
|
10820
|
+
]
|
|
10821
|
+
},
|
|
10822
|
+
"interfaces": [
|
|
10823
|
+
"@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails"
|
|
10824
|
+
],
|
|
10825
|
+
"kind": "class",
|
|
10826
|
+
"locationInModule": {
|
|
10827
|
+
"filename": "src/services/ServiceAvailabilityMetricDetails.ts",
|
|
10828
|
+
"line": 10
|
|
10829
|
+
},
|
|
10830
|
+
"name": "ServiceAvailabilityMetricDetails",
|
|
10831
|
+
"properties": [
|
|
10832
|
+
{
|
|
10833
|
+
"docs": {
|
|
10834
|
+
"stability": "experimental",
|
|
10835
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
10836
|
+
},
|
|
10837
|
+
"immutable": true,
|
|
10838
|
+
"locationInModule": {
|
|
10839
|
+
"filename": "src/services/ServiceAvailabilityMetricDetails.ts",
|
|
10840
|
+
"line": 23
|
|
10841
|
+
},
|
|
10842
|
+
"name": "faultAlarmThreshold",
|
|
10843
|
+
"overrides": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails",
|
|
10844
|
+
"type": {
|
|
10845
|
+
"primitive": "number"
|
|
10846
|
+
}
|
|
10847
|
+
},
|
|
10848
|
+
{
|
|
10849
|
+
"docs": {
|
|
10850
|
+
"stability": "experimental",
|
|
10851
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
10852
|
+
},
|
|
10853
|
+
"immutable": true,
|
|
10854
|
+
"locationInModule": {
|
|
10855
|
+
"filename": "src/services/ServiceAvailabilityMetricDetails.ts",
|
|
10856
|
+
"line": 16
|
|
10857
|
+
},
|
|
10858
|
+
"name": "successAlarmThreshold",
|
|
10859
|
+
"overrides": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails",
|
|
10860
|
+
"type": {
|
|
10861
|
+
"primitive": "number"
|
|
10862
|
+
}
|
|
10863
|
+
}
|
|
10864
|
+
],
|
|
10865
|
+
"symbolId": "src/services/ServiceAvailabilityMetricDetails:ServiceAvailabilityMetricDetails"
|
|
10866
|
+
},
|
|
10867
|
+
"@cdklabs/multi-az-observability.ServiceAvailabilityMetricDetailsProps": {
|
|
10868
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
10869
|
+
"datatype": true,
|
|
10870
|
+
"docs": {
|
|
10871
|
+
"stability": "experimental",
|
|
10872
|
+
"summary": "Props for service availability metrics."
|
|
10873
|
+
},
|
|
10874
|
+
"fqn": "@cdklabs/multi-az-observability.ServiceAvailabilityMetricDetailsProps",
|
|
10875
|
+
"interfaces": [
|
|
10876
|
+
"@cdklabs/multi-az-observability.ServiceMetricDetailsProps"
|
|
10877
|
+
],
|
|
10878
|
+
"kind": "interface",
|
|
10879
|
+
"locationInModule": {
|
|
10880
|
+
"filename": "src/services/props/ServiceAvailabilityMetricDetailsProps.ts",
|
|
10881
|
+
"line": 8
|
|
10882
|
+
},
|
|
10883
|
+
"name": "ServiceAvailabilityMetricDetailsProps",
|
|
10884
|
+
"properties": [
|
|
10885
|
+
{
|
|
10886
|
+
"abstract": true,
|
|
10887
|
+
"docs": {
|
|
10888
|
+
"stability": "experimental",
|
|
10889
|
+
"summary": "The threshold for alarms associated with availability fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
10890
|
+
},
|
|
10891
|
+
"immutable": true,
|
|
10892
|
+
"locationInModule": {
|
|
10893
|
+
"filename": "src/services/props/ServiceAvailabilityMetricDetailsProps.ts",
|
|
10894
|
+
"line": 21
|
|
10895
|
+
},
|
|
10896
|
+
"name": "faultAlarmThreshold",
|
|
10897
|
+
"type": {
|
|
10898
|
+
"primitive": "number"
|
|
10899
|
+
}
|
|
10900
|
+
},
|
|
10901
|
+
{
|
|
10902
|
+
"abstract": true,
|
|
10903
|
+
"docs": {
|
|
10904
|
+
"stability": "experimental",
|
|
10905
|
+
"summary": "The threshold for alarms associated with availability success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
10906
|
+
},
|
|
10907
|
+
"immutable": true,
|
|
10908
|
+
"locationInModule": {
|
|
10909
|
+
"filename": "src/services/props/ServiceAvailabilityMetricDetailsProps.ts",
|
|
10910
|
+
"line": 14
|
|
10911
|
+
},
|
|
10912
|
+
"name": "successAlarmThreshold",
|
|
10913
|
+
"type": {
|
|
10914
|
+
"primitive": "number"
|
|
10915
|
+
}
|
|
10916
|
+
}
|
|
10917
|
+
],
|
|
10918
|
+
"symbolId": "src/services/props/ServiceAvailabilityMetricDetailsProps:ServiceAvailabilityMetricDetailsProps"
|
|
10919
|
+
},
|
|
10920
|
+
"@cdklabs/multi-az-observability.ServiceLatencyMetricDetails": {
|
|
10921
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
10922
|
+
"base": "@cdklabs/multi-az-observability.ServiceMetricDetails",
|
|
10923
|
+
"docs": {
|
|
10924
|
+
"stability": "experimental",
|
|
10925
|
+
"summary": "Default latency metric details for a service."
|
|
10926
|
+
},
|
|
10927
|
+
"fqn": "@cdklabs/multi-az-observability.ServiceLatencyMetricDetails",
|
|
10928
|
+
"initializer": {
|
|
10929
|
+
"docs": {
|
|
10930
|
+
"stability": "experimental"
|
|
10931
|
+
},
|
|
10932
|
+
"locationInModule": {
|
|
10933
|
+
"filename": "src/services/ServiceLatencyMetricDetails.ts",
|
|
10934
|
+
"line": 18
|
|
10935
|
+
},
|
|
10936
|
+
"parameters": [
|
|
10937
|
+
{
|
|
10938
|
+
"name": "props",
|
|
10939
|
+
"type": {
|
|
10940
|
+
"fqn": "@cdklabs/multi-az-observability.ServiceLatencyMetricDetailsProps"
|
|
10941
|
+
}
|
|
10942
|
+
}
|
|
10943
|
+
]
|
|
10944
|
+
},
|
|
10945
|
+
"interfaces": [
|
|
10946
|
+
"@cdklabs/multi-az-observability.IServiceLatencyMetricDetails"
|
|
10947
|
+
],
|
|
10948
|
+
"kind": "class",
|
|
10949
|
+
"locationInModule": {
|
|
10950
|
+
"filename": "src/services/ServiceLatencyMetricDetails.ts",
|
|
10951
|
+
"line": 11
|
|
10952
|
+
},
|
|
10953
|
+
"name": "ServiceLatencyMetricDetails",
|
|
10954
|
+
"properties": [
|
|
10955
|
+
{
|
|
10956
|
+
"docs": {
|
|
10957
|
+
"stability": "experimental",
|
|
10958
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
10959
|
+
},
|
|
10960
|
+
"immutable": true,
|
|
10961
|
+
"locationInModule": {
|
|
10962
|
+
"filename": "src/services/ServiceLatencyMetricDetails.ts",
|
|
10963
|
+
"line": 16
|
|
10964
|
+
},
|
|
10965
|
+
"name": "successAlarmThreshold",
|
|
10966
|
+
"overrides": "@cdklabs/multi-az-observability.IServiceLatencyMetricDetails",
|
|
10967
|
+
"type": {
|
|
10968
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
10969
|
+
}
|
|
10970
|
+
}
|
|
10971
|
+
],
|
|
10972
|
+
"symbolId": "src/services/ServiceLatencyMetricDetails:ServiceLatencyMetricDetails"
|
|
10973
|
+
},
|
|
10974
|
+
"@cdklabs/multi-az-observability.ServiceLatencyMetricDetailsProps": {
|
|
10975
|
+
"assembly": "@cdklabs/multi-az-observability",
|
|
10976
|
+
"datatype": true,
|
|
10977
|
+
"docs": {
|
|
10978
|
+
"stability": "experimental",
|
|
10979
|
+
"summary": "Props for service latency metrics."
|
|
10980
|
+
},
|
|
10981
|
+
"fqn": "@cdklabs/multi-az-observability.ServiceLatencyMetricDetailsProps",
|
|
10982
|
+
"interfaces": [
|
|
10983
|
+
"@cdklabs/multi-az-observability.ServiceMetricDetailsProps"
|
|
10984
|
+
],
|
|
10985
|
+
"kind": "interface",
|
|
10986
|
+
"locationInModule": {
|
|
10987
|
+
"filename": "src/services/props/ServiceLatencyMetricDetailsProps.ts",
|
|
10988
|
+
"line": 9
|
|
10989
|
+
},
|
|
10990
|
+
"name": "ServiceLatencyMetricDetailsProps",
|
|
10991
|
+
"properties": [
|
|
10992
|
+
{
|
|
10993
|
+
"abstract": true,
|
|
10994
|
+
"docs": {
|
|
10995
|
+
"stability": "experimental",
|
|
10996
|
+
"summary": "The threshold for alarms associated with latency success metrics, for example if success latency exceeds 500 milliseconds."
|
|
10997
|
+
},
|
|
10998
|
+
"immutable": true,
|
|
10999
|
+
"locationInModule": {
|
|
11000
|
+
"filename": "src/services/props/ServiceLatencyMetricDetailsProps.ts",
|
|
11001
|
+
"line": 14
|
|
11002
|
+
},
|
|
11003
|
+
"name": "successAlarmThreshold",
|
|
11004
|
+
"type": {
|
|
11005
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
11006
|
+
}
|
|
11007
|
+
}
|
|
11008
|
+
],
|
|
11009
|
+
"symbolId": "src/services/props/ServiceLatencyMetricDetailsProps:ServiceLatencyMetricDetailsProps"
|
|
11010
|
+
},
|
|
9722
11011
|
"@cdklabs/multi-az-observability.ServiceMetricDetails": {
|
|
11012
|
+
"abstract": true,
|
|
9723
11013
|
"assembly": "@cdklabs/multi-az-observability",
|
|
9724
11014
|
"docs": {
|
|
9725
11015
|
"stability": "experimental",
|
|
@@ -9732,7 +11022,7 @@
|
|
|
9732
11022
|
},
|
|
9733
11023
|
"locationInModule": {
|
|
9734
11024
|
"filename": "src/services/ServiceMetricDetails.ts",
|
|
9735
|
-
"line":
|
|
11025
|
+
"line": 71
|
|
9736
11026
|
},
|
|
9737
11027
|
"parameters": [
|
|
9738
11028
|
{
|
|
@@ -9801,22 +11091,6 @@
|
|
|
9801
11091
|
"primitive": "number"
|
|
9802
11092
|
}
|
|
9803
11093
|
},
|
|
9804
|
-
{
|
|
9805
|
-
"docs": {
|
|
9806
|
-
"stability": "experimental",
|
|
9807
|
-
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
9808
|
-
},
|
|
9809
|
-
"immutable": true,
|
|
9810
|
-
"locationInModule": {
|
|
9811
|
-
"filename": "src/services/ServiceMetricDetails.ts",
|
|
9812
|
-
"line": 83
|
|
9813
|
-
},
|
|
9814
|
-
"name": "faultAlarmThreshold",
|
|
9815
|
-
"overrides": "@cdklabs/multi-az-observability.IServiceMetricDetails",
|
|
9816
|
-
"type": {
|
|
9817
|
-
"primitive": "number"
|
|
9818
|
-
}
|
|
9819
|
-
},
|
|
9820
11094
|
{
|
|
9821
11095
|
"docs": {
|
|
9822
11096
|
"stability": "experimental",
|
|
@@ -9870,22 +11144,6 @@
|
|
|
9870
11144
|
"fqn": "aws-cdk-lib.Duration"
|
|
9871
11145
|
}
|
|
9872
11146
|
},
|
|
9873
|
-
{
|
|
9874
|
-
"docs": {
|
|
9875
|
-
"stability": "experimental",
|
|
9876
|
-
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
9877
|
-
},
|
|
9878
|
-
"immutable": true,
|
|
9879
|
-
"locationInModule": {
|
|
9880
|
-
"filename": "src/services/ServiceMetricDetails.ts",
|
|
9881
|
-
"line": 76
|
|
9882
|
-
},
|
|
9883
|
-
"name": "successAlarmThreshold",
|
|
9884
|
-
"overrides": "@cdklabs/multi-az-observability.IServiceMetricDetails",
|
|
9885
|
-
"type": {
|
|
9886
|
-
"primitive": "number"
|
|
9887
|
-
}
|
|
9888
|
-
},
|
|
9889
11147
|
{
|
|
9890
11148
|
"docs": {
|
|
9891
11149
|
"stability": "experimental",
|
|
@@ -10037,22 +11295,6 @@
|
|
|
10037
11295
|
"primitive": "number"
|
|
10038
11296
|
}
|
|
10039
11297
|
},
|
|
10040
|
-
{
|
|
10041
|
-
"abstract": true,
|
|
10042
|
-
"docs": {
|
|
10043
|
-
"stability": "experimental",
|
|
10044
|
-
"summary": "The threshold for alarms associated with fault metrics, for example if measuring fault rate, the threshold may be 1, meaning you would want an alarm that triggers if the fault rate goes above 1%."
|
|
10045
|
-
},
|
|
10046
|
-
"immutable": true,
|
|
10047
|
-
"locationInModule": {
|
|
10048
|
-
"filename": "src/services/props/ServiceMetricDetailsProps.ts",
|
|
10049
|
-
"line": 81
|
|
10050
|
-
},
|
|
10051
|
-
"name": "faultAlarmThreshold",
|
|
10052
|
-
"type": {
|
|
10053
|
-
"primitive": "number"
|
|
10054
|
-
}
|
|
10055
|
-
},
|
|
10056
11298
|
{
|
|
10057
11299
|
"abstract": true,
|
|
10058
11300
|
"docs": {
|
|
@@ -10106,22 +11348,6 @@
|
|
|
10106
11348
|
"fqn": "aws-cdk-lib.Duration"
|
|
10107
11349
|
}
|
|
10108
11350
|
},
|
|
10109
|
-
{
|
|
10110
|
-
"abstract": true,
|
|
10111
|
-
"docs": {
|
|
10112
|
-
"stability": "experimental",
|
|
10113
|
-
"summary": "The threshold for alarms associated with success metrics, for example if measuring success rate, the threshold may be 99, meaning you would want an alarm that triggers if success drops below 99%."
|
|
10114
|
-
},
|
|
10115
|
-
"immutable": true,
|
|
10116
|
-
"locationInModule": {
|
|
10117
|
-
"filename": "src/services/props/ServiceMetricDetailsProps.ts",
|
|
10118
|
-
"line": 74
|
|
10119
|
-
},
|
|
10120
|
-
"name": "successAlarmThreshold",
|
|
10121
|
-
"type": {
|
|
10122
|
-
"primitive": "number"
|
|
10123
|
-
}
|
|
10124
|
-
},
|
|
10125
11351
|
{
|
|
10126
11352
|
"abstract": true,
|
|
10127
11353
|
"docs": {
|
|
@@ -10221,7 +11447,7 @@
|
|
|
10221
11447
|
"kind": "interface",
|
|
10222
11448
|
"locationInModule": {
|
|
10223
11449
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10224
|
-
"line":
|
|
11450
|
+
"line": 13
|
|
10225
11451
|
},
|
|
10226
11452
|
"name": "ServiceProps",
|
|
10227
11453
|
"properties": [
|
|
@@ -10234,7 +11460,7 @@
|
|
|
10234
11460
|
"immutable": true,
|
|
10235
11461
|
"locationInModule": {
|
|
10236
11462
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10237
|
-
"line":
|
|
11463
|
+
"line": 34
|
|
10238
11464
|
},
|
|
10239
11465
|
"name": "availabilityZoneNames",
|
|
10240
11466
|
"type": {
|
|
@@ -10255,7 +11481,7 @@
|
|
|
10255
11481
|
"immutable": true,
|
|
10256
11482
|
"locationInModule": {
|
|
10257
11483
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10258
|
-
"line":
|
|
11484
|
+
"line": 23
|
|
10259
11485
|
},
|
|
10260
11486
|
"name": "baseUrl",
|
|
10261
11487
|
"type": {
|
|
@@ -10271,11 +11497,11 @@
|
|
|
10271
11497
|
"immutable": true,
|
|
10272
11498
|
"locationInModule": {
|
|
10273
11499
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10274
|
-
"line":
|
|
11500
|
+
"line": 65
|
|
10275
11501
|
},
|
|
10276
11502
|
"name": "defaultAvailabilityMetricDetails",
|
|
10277
11503
|
"type": {
|
|
10278
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
11504
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceAvailabilityMetricDetails"
|
|
10279
11505
|
}
|
|
10280
11506
|
},
|
|
10281
11507
|
{
|
|
@@ -10287,11 +11513,11 @@
|
|
|
10287
11513
|
"immutable": true,
|
|
10288
11514
|
"locationInModule": {
|
|
10289
11515
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10290
|
-
"line":
|
|
11516
|
+
"line": 72
|
|
10291
11517
|
},
|
|
10292
11518
|
"name": "defaultLatencyMetricDetails",
|
|
10293
11519
|
"type": {
|
|
10294
|
-
"fqn": "@cdklabs/multi-az-observability.
|
|
11520
|
+
"fqn": "@cdklabs/multi-az-observability.IServiceLatencyMetricDetails"
|
|
10295
11521
|
}
|
|
10296
11522
|
},
|
|
10297
11523
|
{
|
|
@@ -10304,7 +11530,7 @@
|
|
|
10304
11530
|
"immutable": true,
|
|
10305
11531
|
"locationInModule": {
|
|
10306
11532
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10307
|
-
"line":
|
|
11533
|
+
"line": 29
|
|
10308
11534
|
},
|
|
10309
11535
|
"name": "faultCountThreshold",
|
|
10310
11536
|
"type": {
|
|
@@ -10320,7 +11546,7 @@
|
|
|
10320
11546
|
"immutable": true,
|
|
10321
11547
|
"locationInModule": {
|
|
10322
11548
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10323
|
-
"line":
|
|
11549
|
+
"line": 39
|
|
10324
11550
|
},
|
|
10325
11551
|
"name": "period",
|
|
10326
11552
|
"type": {
|
|
@@ -10336,7 +11562,7 @@
|
|
|
10336
11562
|
"immutable": true,
|
|
10337
11563
|
"locationInModule": {
|
|
10338
11564
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10339
|
-
"line":
|
|
11565
|
+
"line": 17
|
|
10340
11566
|
},
|
|
10341
11567
|
"name": "serviceName",
|
|
10342
11568
|
"type": {
|
|
@@ -10354,7 +11580,7 @@
|
|
|
10354
11580
|
"immutable": true,
|
|
10355
11581
|
"locationInModule": {
|
|
10356
11582
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10357
|
-
"line":
|
|
11583
|
+
"line": 58
|
|
10358
11584
|
},
|
|
10359
11585
|
"name": "canaryTestProps",
|
|
10360
11586
|
"optional": true,
|
|
@@ -10372,7 +11598,7 @@
|
|
|
10372
11598
|
"immutable": true,
|
|
10373
11599
|
"locationInModule": {
|
|
10374
11600
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10375
|
-
"line":
|
|
11601
|
+
"line": 81
|
|
10376
11602
|
},
|
|
10377
11603
|
"name": "defaultContributorInsightRuleDetails",
|
|
10378
11604
|
"optional": true,
|
|
@@ -10390,7 +11616,7 @@
|
|
|
10390
11616
|
"immutable": true,
|
|
10391
11617
|
"locationInModule": {
|
|
10392
11618
|
"filename": "src/services/props/ServiceProps.ts",
|
|
10393
|
-
"line":
|
|
11619
|
+
"line": 48
|
|
10394
11620
|
},
|
|
10395
11621
|
"name": "loadBalancer",
|
|
10396
11622
|
"optional": true,
|
|
@@ -10402,6 +11628,6 @@
|
|
|
10402
11628
|
"symbolId": "src/services/props/ServiceProps:ServiceProps"
|
|
10403
11629
|
}
|
|
10404
11630
|
},
|
|
10405
|
-
"version": "0.0.1-alpha.
|
|
10406
|
-
"fingerprint": "
|
|
11631
|
+
"version": "0.0.1-alpha.40",
|
|
11632
|
+
"fingerprint": "MfHoRh0qqixaV0F3Wa6caRDj1tYe31USDBvwpJRKn9o="
|
|
10407
11633
|
}
|