Struct relay_dynamic_config::Options

pub struct Options {

    pub profile_metrics_allowed_platforms: Vec<String>,
    pub profile_metrics_sample_rate: f32,
    pub unsampled_profiles_enabled: bool,
    pub profiles_function_generic_metrics_enabled: bool,
    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 feedback_ingest_topic_rollout_rate: f32,
    pub feedback_ingest_same_envelope_attachments: bool,
    pub span_extraction_sample_rate: Option<f32>,
    pub force_full_normalization: bool,
    pub processing_disable_normalization: bool,
    /* private fields */
}

All options passed down from Sentry to Relay.

Fields

profile_metrics_allowed_platforms: Vec<String>

List of platform names for which we allow using unsampled profiles for the purpose of improving profile (function) metrics

profile_metrics_sample_rate: f32

Sample rate for tuning the amount of unsampled profiles that we “let through”

unsampled_profiles_enabled: bool

Kill switch for shutting down unsampled_profile metrics

profiles_function_generic_metrics_enabled: bool

Kill switch for shutting down profile function metrics ingestion in the generic-metrics platform

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.

feedback_ingest_topic_rollout_rate: f32

Rollout rate for producing to the ingest-feedback-events topic.

Rate needs to be between 0.0 and 1.0. If set to 1.0 all organizations will ingest to the feedback topic.

feedback_ingest_same_envelope_attachments: bool

Flag for handling feedback and attachments in the same envelope. This is for the SDK team to send less requests for the user feedback screenshots feature. Prior to this change, feedback sent w/attachments would be produced to the attachments topic, rather than its own topic. The items are now split up accordingly.

This option is used as a temporary FF/kill-switch to toggle back to the old code path in relay’s StoreService. This is for testing convenience and will be removed after user feedback’s GA release.

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::ExtractSpansAndSpanMetricsFromEvent, 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.

force_full_normalization: bool

If enabled, runs full normalization in non-processing Relays.

Doesn’t apply to processing Relays. Outdated relays with a stale protocol/normalization receiving this flag will not forward unknown fields. Disabling the flag solves this behavior.

processing_disable_normalization: bool

If enabled, disables normalization in processing Relays.

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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