A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.
Contents
- FixedRate
-
The percentage of matching requests to instrument, after the reservoir is exhausted.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
- Host
-
Matches the hostname from a request URL.
Type: String
Length Constraints: Maximum length of 64.
Required: Yes
- HTTPMethod
-
Matches the HTTP method of a request.
Type: String
Length Constraints: Maximum length of 10.
Required: Yes
- Priority
-
The priority of the sampling rule.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 9999.
Required: Yes
- ReservoirSize
-
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
- ResourceARN
-
Matches the ARN of the AWS resource on which the service runs.
Type: String
Length Constraints: Maximum length of 500.
Required: Yes
- ServiceName
-
Matches the
namethat the service uses to identify itself in segments.Type: String
Length Constraints: Maximum length of 64.
Required: Yes
- ServiceType
-
Matches the
originthat the service uses to identify its type in segments.Type: String
Length Constraints: Maximum length of 64.
Required: Yes
- URLPath
-
Matches the path from a request URL.
Type: String
Length Constraints: Maximum length of 128.
Required: Yes
- Version
-
The version of the sampling rule format (
1).Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
- Attributes
-
Matches attributes derived from the request.
Type: String to string map
Map Entries: Maximum number of 5 items.
Key Length Constraints: Minimum length of 1. Maximum length of 32.
Value Length Constraints: Minimum length of 1. Maximum length of 32.
Required: No
- RuleARN
-
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
Type: String
Required: No
- RuleName
-
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
