Struct Options

pub struct Options {
    pub cardinality_limiter_mode: CardinalityLimiterMode,
    pub cardinality_limiter_error_sample_rate: f32,
    pub metric_bucket_set_encodings: BucketEncodings,
    pub metric_bucket_dist_encodings: BucketEncodings,
    pub metric_stats_rollout_rate: f32,
    pub span_extraction_sample_rate: Option<f32>,
    pub http_span_allowed_hosts: Vec<String>,
    /* private fields */
}

All options passed down from Sentry to Relay.

Fields

cardinality_limiter_mode: CardinalityLimiterMode

Kill switch for controlling the cardinality limiter.

cardinality_limiter_error_sample_rate: f32

Sample rate for Cardinality Limiter Sentry errors.

Rate needs to be between 0.0 and 1.0. If set to 1.0 all cardinality limiter rejections will be logged as a Sentry error.

metric_bucket_set_encodings: BucketEncodings

Metric bucket encoding configuration for sets by metric namespace.

metric_bucket_dist_encodings: BucketEncodings

Metric bucket encoding configuration for distributions by metric namespace.

metric_stats_rollout_rate: f32

Rollout rate for metric stats.

Rate needs to be between 0.0 and 1.0. If set to 1.0 all organizations will have metric stats enabled.

span_extraction_sample_rate: Option<f32>

Overall sampling of span extraction.

This number represents the fraction of transactions for which spans are extracted. It applies on top of crate::Feature::ExtractCommonSpanMetricsFromEvent, so both feature flag and sample rate need to be enabled to get any spans extracted.

None is the default and interpreted as a value of 1.0 (extract everything).

Note: Any value below 1.0 will cause the product to break, so use with caution.

http_span_allowed_hosts: Vec<String>

List of values on span description that are allowed to be sent to Sentry without being scrubbed.

At this point, it doesn’t accept IP addresses in CIDR format.. yet.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

where Options: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Options

fn eq(&self, other: &Options) -> 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 Serialize for Options

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Options