Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.XRay.Types.SamplingRule
Description
Synopsis
- data SamplingRule = SamplingRule' {}
- newSamplingRule :: Text -> Natural -> Double -> Natural -> Text -> Text -> Text -> Text -> Text -> Natural -> SamplingRule
- samplingRule_ruleName :: Lens' SamplingRule (Maybe Text)
- samplingRule_attributes :: Lens' SamplingRule (Maybe (HashMap Text Text))
- samplingRule_ruleARN :: Lens' SamplingRule (Maybe Text)
- samplingRule_resourceARN :: Lens' SamplingRule Text
- samplingRule_priority :: Lens' SamplingRule Natural
- samplingRule_fixedRate :: Lens' SamplingRule Double
- samplingRule_reservoirSize :: Lens' SamplingRule Natural
- samplingRule_serviceName :: Lens' SamplingRule Text
- samplingRule_serviceType :: Lens' SamplingRule Text
- samplingRule_host :: Lens' SamplingRule Text
- samplingRule_hTTPMethod :: Lens' SamplingRule Text
- samplingRule_uRLPath :: Lens' SamplingRule Text
- samplingRule_version :: Lens' SamplingRule Natural
Documentation
data SamplingRule Source #
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.
See: newSamplingRule
smart constructor.
Constructors
SamplingRule' | |
Fields
|
Instances
Arguments
:: Text | |
-> Natural | |
-> Double | |
-> Natural | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Natural | |
-> SamplingRule |
Create a value of SamplingRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ruleName:SamplingRule'
, samplingRule_ruleName
- The name of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:attributes:SamplingRule'
, samplingRule_attributes
- Matches attributes derived from the request.
$sel:ruleARN:SamplingRule'
, samplingRule_ruleARN
- The ARN of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:resourceARN:SamplingRule'
, samplingRule_resourceARN
- Matches the ARN of the Amazon Web Services resource on which the service
runs.
$sel:priority:SamplingRule'
, samplingRule_priority
- The priority of the sampling rule.
$sel:fixedRate:SamplingRule'
, samplingRule_fixedRate
- The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:reservoirSize:SamplingRule'
, samplingRule_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.
$sel:serviceName:SamplingRule'
, samplingRule_serviceName
- Matches the name
that the service uses to identify itself in segments.
$sel:serviceType:SamplingRule'
, samplingRule_serviceType
- Matches the origin
that the service uses to identify its type in
segments.
$sel:host:SamplingRule'
, samplingRule_host
- Matches the hostname from a request URL.
$sel:hTTPMethod:SamplingRule'
, samplingRule_hTTPMethod
- Matches the HTTP method of a request.
$sel:uRLPath:SamplingRule'
, samplingRule_uRLPath
- Matches the path from a request URL.
$sel:version:SamplingRule'
, samplingRule_version
- The version of the sampling rule format (1
).
samplingRule_ruleName :: Lens' SamplingRule (Maybe Text) Source #
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
samplingRule_attributes :: Lens' SamplingRule (Maybe (HashMap Text Text)) Source #
Matches attributes derived from the request.
samplingRule_ruleARN :: Lens' SamplingRule (Maybe Text) Source #
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
samplingRule_resourceARN :: Lens' SamplingRule Text Source #
Matches the ARN of the Amazon Web Services resource on which the service runs.
samplingRule_priority :: Lens' SamplingRule Natural Source #
The priority of the sampling rule.
samplingRule_fixedRate :: Lens' SamplingRule Double Source #
The percentage of matching requests to instrument, after the reservoir is exhausted.
samplingRule_reservoirSize :: Lens' SamplingRule Natural Source #
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.
samplingRule_serviceName :: Lens' SamplingRule Text Source #
Matches the name
that the service uses to identify itself in segments.
samplingRule_serviceType :: Lens' SamplingRule Text Source #
Matches the origin
that the service uses to identify its type in
segments.
samplingRule_host :: Lens' SamplingRule Text Source #
Matches the hostname from a request URL.
samplingRule_hTTPMethod :: Lens' SamplingRule Text Source #
Matches the HTTP method of a request.
samplingRule_uRLPath :: Lens' SamplingRule Text Source #
Matches the path from a request URL.
samplingRule_version :: Lens' SamplingRule Natural Source #
The version of the sampling rule format (1
).