Struct SamplingRateBoost 

#[non_exhaustive]
pub struct SamplingRateBoost {
    pub max_rate: f64,
    pub cooldown_window_minutes: i32,
}

Enable temporary sampling rate increases when you detect anomalies to improve visibility.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_rate: f64

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.

cooldown_window_minutes: i32

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.

Implementations

impl SamplingRateBoost

pub fn max_rate(&self) -> f64

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.

pub fn cooldown_window_minutes(&self) -> i32

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.

impl SamplingRateBoost

pub fn builder() -> SamplingRateBoostBuilder

Creates a new builder-style object to manufacture SamplingRateBoost.

Trait Implementations

impl Clone for SamplingRateBoost

fn clone(&self) -> SamplingRateBoost

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SamplingRateBoost

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SamplingRateBoost

fn eq(&self, other: &SamplingRateBoost) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SamplingRateBoost