Amazonka.XRay.Types.SamplingTargetDocument

Documentation

data SamplingTargetDocument

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

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

• reservoirQuota :: Maybe Int

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

• reservoirQuotaTTL :: Maybe POSIX

  When the reservoir quota expires.

• ruleName :: Maybe Text

  The name of the sampling rule.

Instances

FromJSON SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Methods

parseJSON :: Value -> Parser SamplingTargetDocument

parseJSONList :: Value -> Parser [SamplingTargetDocument]

Generic SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Associated Types

type Rep SamplingTargetDocument :: Type -> Type

Methods

from :: SamplingTargetDocument -> Rep SamplingTargetDocument x

to :: Rep SamplingTargetDocument x -> SamplingTargetDocument

Read SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Methods

readsPrec :: Int -> ReadS SamplingTargetDocument

readList :: ReadS [SamplingTargetDocument]

readPrec :: ReadPrec SamplingTargetDocument

readListPrec :: ReadPrec [SamplingTargetDocument]

Show SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Methods

showsPrec :: Int -> SamplingTargetDocument -> ShowS

show :: SamplingTargetDocument -> String

showList :: [SamplingTargetDocument] -> ShowS

NFData SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Methods

rnf :: SamplingTargetDocument -> ()

Eq SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Methods

(==) :: SamplingTargetDocument -> SamplingTargetDocument -> Bool

(/=) :: SamplingTargetDocument -> SamplingTargetDocument -> Bool

Hashable SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

Methods

hashWithSalt :: Int -> SamplingTargetDocument -> Int

hash :: SamplingTargetDocument -> Int

type Rep SamplingTargetDocument

Defined in Amazonka.XRay.Types.SamplingTargetDocument

type Rep SamplingTargetDocument = D1 ('MetaData "SamplingTargetDocument" "Amazonka.XRay.Types.SamplingTargetDocument" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "SamplingTargetDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fixedRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "reservoirQuota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "reservoirQuotaTTL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newSamplingTargetDocument :: SamplingTargetDocument

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

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

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

samplingTargetDocument_fixedRate :: Lens' SamplingTargetDocument (Maybe Double)

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

samplingTargetDocument_interval :: Lens' SamplingTargetDocument (Maybe Int)

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

samplingTargetDocument_reservoirQuota :: Lens' SamplingTargetDocument (Maybe Int)

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

samplingTargetDocument_reservoirQuotaTTL :: Lens' SamplingTargetDocument (Maybe UTCTime)

When the reservoir quota expires.

samplingTargetDocument_ruleName :: Lens' SamplingTargetDocument (Maybe Text)

The name of the sampling rule.