RequestBasedServiceLevelIndicatorMetricConfig
Use this structure to specify the information for the metric that a period-based SLO will monitor.
Contents
- DependencyConfig
-
Identifies the dependency using the
DependencyKeyAttributesandDependencyOperationName.Type: DependencyConfig object
Required: No
- KeyAttributes
-
If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the
Type,Name, andEnvironmentattributes.This is a string-to-string map. It can include the following fields.
-
Typedesignates the type of object this is. -
ResourceTypespecifies the type of the resource. This field is used only when the value of theTypefield isResourceorAWS::Resource. -
Namespecifies the name of the object. This is used only if the value of theTypefield isService,RemoteService, orAWS::Service. -
Identifieridentifies the resource objects of this resource. This is used only if the value of theTypefield isResourceorAWS::Resource. -
Environmentspecifies the location where this object is hosted, or what it belongs to.
Type: String to string map
Map Entries: Maximum number of 4 items.
Key Pattern:
[a-zA-Z]{1,50}Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Value Pattern:
[ -~]*[!-~]+[ -~]*Required: No
-
- MetricType
-
If the SLO is to monitor either the
LATENCYorAVAILABILITYmetric that Application Signals collects, use this field to specify which of those metrics is used.Type: String
Valid Values:
LATENCY | AVAILABILITYRequired: No
- MonitoredRequestCountMetric
-
Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in
TotalRequestCountMetricwill be divided by the number found forMonitoredRequestCountMetricto determine the percentage of successful requests that this SLO tracks.Type: MonitoredRequestCountMetricDataQueries object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- OperationName
-
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- TotalRequestCountMetric
-
Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in
MonitoredRequestCountMetric.Type: Array of MetricDataQuery objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: