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.SamplingTargetDocument

Description

Documentation

data SamplingTargetDocument Source #

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

See: newSamplingTargetDocument smart constructor.

Constructors

SamplingTargetDocument'

Fields

reservoirQuota :: Maybe Int
The number of requests per second that X-Ray allocated for this service.
ruleName :: Maybe Text
The name of the sampling rule.
fixedRate :: Maybe Double
The percentage of matching requests to instrument, after the reservoir is exhausted.
interval :: Maybe Int
The number of seconds for the service to wait before getting sampling targets again.
reservoirQuotaTTL :: Maybe POSIX
When the reservoir quota expires.

Instances

Instances details

Eq SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Methods (==) :: SamplingTargetDocument -> SamplingTargetDocument -> Bool # (/=) :: SamplingTargetDocument -> SamplingTargetDocument -> Bool #
Read SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Methods readsPrec :: Int -> ReadS SamplingTargetDocument # readList :: ReadS [SamplingTargetDocument] # readPrec :: ReadPrec SamplingTargetDocument # readListPrec :: ReadPrec [SamplingTargetDocument] #
Show SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Methods showsPrec :: Int -> SamplingTargetDocument -> ShowS # show :: SamplingTargetDocument -> String # showList :: [SamplingTargetDocument] -> ShowS #
Generic SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Associated Types type Rep SamplingTargetDocument :: Type -> Type # Methods from :: SamplingTargetDocument -> Rep SamplingTargetDocument x # to :: Rep SamplingTargetDocument x -> SamplingTargetDocument #
NFData SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Methods rnf :: SamplingTargetDocument -> () #
Hashable SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Methods hashWithSalt :: Int -> SamplingTargetDocument -> Int # hash :: SamplingTargetDocument -> Int #
FromJSON SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument Methods parseJSON :: Value -> Parser SamplingTargetDocument # parseJSONList :: Value -> Parser [SamplingTargetDocument] #
type Rep SamplingTargetDocument Source #
Instance details Defined in Amazonka.XRay.Types.SamplingTargetDocument type Rep SamplingTargetDocument = D1 ('MetaData "SamplingTargetDocument" "Amazonka.XRay.Types.SamplingTargetDocument" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "SamplingTargetDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reservoirQuota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "fixedRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "reservoirQuotaTTL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newSamplingTargetDocument :: SamplingTargetDocument Source #

Create a value of SamplingTargetDocument 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:reservoirQuota:SamplingTargetDocument', samplingTargetDocument_reservoirQuota - The number of requests per second that X-Ray allocated for this service.

$sel:ruleName:SamplingTargetDocument', samplingTargetDocument_ruleName - The name of the sampling rule.

$sel:fixedRate:SamplingTargetDocument', samplingTargetDocument_fixedRate - The percentage of matching requests to instrument, after the reservoir is exhausted.

$sel:interval:SamplingTargetDocument', samplingTargetDocument_interval - The number of seconds for the service to wait before getting sampling targets again.

$sel:reservoirQuotaTTL:SamplingTargetDocument', samplingTargetDocument_reservoirQuotaTTL - When the reservoir quota expires.

samplingTargetDocument_reservoirQuota :: Lens' SamplingTargetDocument (Maybe Int) Source #

The number of requests per second that X-Ray allocated for this service.

samplingTargetDocument_ruleName :: Lens' SamplingTargetDocument (Maybe Text) Source #

The name of the sampling rule.

samplingTargetDocument_fixedRate :: Lens' SamplingTargetDocument (Maybe Double) Source #

The percentage of matching requests to instrument, after the reservoir is exhausted.

samplingTargetDocument_interval :: Lens' SamplingTargetDocument (Maybe Int) Source #

The number of seconds for the service to wait before getting sampling targets again.

samplingTargetDocument_reservoirQuotaTTL :: Lens' SamplingTargetDocument (Maybe UTCTime) Source #

When the reservoir quota expires.