Skip to content

SamplingRateBoost

Source code in docs_src/capo_xray/types/sampling_rate_boost.py
class SamplingRateBoost(TypedDict, closed=True):
    max_rate: "capo_xray.types.max_rate.MaxRate"
    """<p>Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.</p>"""
    cooldown_window_minutes: (
        "capo_xray.types.cooldown_window_minutes.CooldownWindowMinutes"
    )
    """<p>Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.</p>"""

cooldown_window_minutes instance-attribute

cooldown_window_minutes: CooldownWindowMinutes

Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.

max_rate instance-attribute

max_rate: MaxRate

Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.