AWS::ApplicationSignals::ServiceLevelObjective RequestBasedSliMetric
This structure contains the information about the metric that is used for a request-based SLO.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "KeyAttributes" :
String
, "MetricType" :String
, "MonitoredRequestCountMetric" :MonitoredRequestCountMetric
, "OperationName" :String
, "TotalRequestCountMetric" :[ MetricDataQuery, ... ]
}
YAML
KeyAttributes:
String
MetricType:String
MonitoredRequestCountMetric:MonitoredRequestCountMetric
OperationName:String
TotalRequestCountMetric:- MetricDataQuery
Properties
KeyAttributes
-
This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.
-
Type
designates the type of object that this SLO is related to. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
Required: No
Type: String
Pattern:
^.+$
Update requires: No interruption
-
MetricType
-
If the SLO monitors either the
LATENCY
orAVAILABILITY
metric that Application Signals collects, this field displays which of those metrics is used.Required: No
Type: String
Allowed values:
LATENCY | AVAILABILITY
Update requires: No interruption
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
TotalRequestCountMetric
will be divided by the number found forMonitoredRequestCountMetric
to determine the percentage of successful requests that this SLO tracks.Required: No
Type: MonitoredRequestCountMetric
Update requires: No interruption
OperationName
-
If the SLO monitors a specific operation of the service, this field displays that operation name.
Required: No
Type: String
Minimum:
1
Maximum:
255
Update requires: No interruption
TotalRequestCountMetric
-
This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in
MonitoredRequestCountMetric
.Required: No
Type: Array of MetricDataQuery
Update requires: No interruption