Skip to content

SamplingTargetDocument

Source code in docs_src/capo_xray/types/sampling_target_document.py
class SamplingTargetDocument(TypedDict, closed=True):
    rule_name: NotRequired["capo_xray.types.string.String"]
    """<p>The name of the sampling rule.</p>"""
    fixed_rate: "capo_xray.types.double.Double"
    """<p>The percentage of matching requests to instrument, after the reservoir is exhausted.</p>"""
    reservoir_quota: NotRequired["capo_xray.types.nullable_integer.NullableInteger"]
    """<p>The number of requests per second that X-Ray allocated for this service.</p>"""
    reservoir_quota_ttl: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>When the reservoir quota expires.</p>"""
    interval: NotRequired["capo_xray.types.nullable_integer.NullableInteger"]
    """<p>The number of seconds for the service to wait before getting sampling targets again.</p>"""
    sampling_boost: NotRequired["capo_xray.types.sampling_boost.SamplingBoost"]
    """<p>The sampling boost that X-Ray allocated for this service.</p>"""

fixed_rate instance-attribute

fixed_rate: Double

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

interval instance-attribute

interval: NotRequired[NullableInteger]

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

reservoir_quota instance-attribute

reservoir_quota: NotRequired[NullableInteger]

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

reservoir_quota_ttl instance-attribute

reservoir_quota_ttl: NotRequired[Timestamp]

When the reservoir quota expires.

rule_name instance-attribute

rule_name: NotRequired[String]

The name of the sampling rule.

sampling_boost instance-attribute

sampling_boost: NotRequired[SamplingBoost]

The sampling boost that X-Ray allocated for this service.