Struct relay_sampling::config::SamplingConfig

pub struct SamplingConfig {
    pub version: u16,
    pub rules: Vec<SamplingRule>,
    pub rules_v2: Vec<SamplingRule>,
}

Represents the dynamic sampling configuration available to a project.

Note: This comes from the organization data

Fields

version: u16

The required version to run dynamic sampling.

Defaults to legacy version (1) when missing.

rules: Vec<SamplingRule>

The ordered sampling rules for the project.

rules_v2: Vec<SamplingRule>

Deprecated. The ordered sampling rules for the project in legacy format.

Removed in favor of Self::rules in version 2. This field remains here to parse rules from old Sentry instances and convert them into the new format. The legacy format contained both an empty rules as well as the actual rules in rules_v2. During normalization, these two arrays are merged together.

Implementations

impl SamplingConfig

pub fn new() -> Self

Creates an enabled configuration with empty defaults and the latest version.

pub fn unsupported(&self) -> bool

Returns true if any of the rules in this configuration is unsupported.

pub fn filter_rules( &self, rule_type: RuleType ) -> impl Iterator<Item = &SamplingRule>

Filters the sampling rules by the given RuleType.

pub fn normalize(&mut self)

Upgrades legacy sampling configs into the latest format.

Trait Implementations

impl Clone for SamplingConfig

fn clone(&self) -> SamplingConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingConfig

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

Formats the value using the given formatter.

impl Default for SamplingConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SamplingConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SamplingConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.