Struct relay_sampling::config::SamplingRule

pub struct SamplingRule {
    pub condition: RuleCondition,
    pub sampling_value: SamplingValue,
    pub ty: RuleType,
    pub id: RuleId,
    pub time_range: TimeRange,
    pub decaying_fn: DecayingFunction,
}

A sampling rule as it is deserialized from the project configuration.

Fields

condition: RuleCondition

A condition to match for this sampling rule.

Sampling rules do not run if their condition does not match.

sampling_value: SamplingValue

The sample rate to apply when this rule matches.

ty: RuleType

The rule type declares what to apply a dynamic sampling rule to and how.

id: RuleId

The unique identifier of this rule.

time_range: TimeRange

The time range the rule should be applicable in.

The time range is open on both ends by default. If a time range is closed on at least one end, the rule is considered a decaying rule.

decaying_fn: DecayingFunction

Declares how to interpolate the sample rate for rules with bounded time range.

Implementations

impl SamplingRule

pub fn apply_decaying_fn( &self, sample_rate: f64, now: DateTime<Utc>, ) -> Option<f64>

Applies its decaying function to the given sample rate.

Trait Implementations

impl Clone for SamplingRule

fn clone(&self) -> SamplingRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SamplingRule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SamplingRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.