relay_dynamic_config/
project.rs

1use relay_auth::PublicKey;
2use relay_event_normalization::{
3    BreakdownsConfig, MeasurementsConfig, PerformanceScoreConfig, SpanDescriptionRule,
4    TransactionNameRule,
5};
6use relay_filter::ProjectFiltersConfig;
7use relay_pii::{DataScrubbingConfig, PiiConfig};
8use relay_quotas::Quota;
9use relay_sampling::SamplingConfig;
10use serde::{Deserialize, Serialize};
11use serde_json::Value;
12
13use crate::error_boundary::ErrorBoundary;
14use crate::feature::FeatureSet;
15use crate::metrics::{self, MetricExtractionConfig, SessionMetricsConfig, TaggingRule};
16use crate::trusted_relay::TrustedRelayConfig;
17use crate::{GRADUATED_FEATURE_FLAGS, defaults};
18
19/// Dynamic, per-DSN configuration passed down from Sentry.
20#[derive(Debug, Clone, Serialize, Deserialize)]
21#[serde(default, rename_all = "camelCase")]
22pub struct ProjectConfig {
23    /// URLs that are permitted for cross original JavaScript requests.
24    pub allowed_domains: Vec<String>,
25    /// List of relay public keys that are permitted to access this project.
26    pub trusted_relays: Vec<PublicKey>,
27    /// Configuration for trusted Relay behaviour.
28    #[serde(skip_serializing_if = "TrustedRelayConfig::is_empty")]
29    pub trusted_relay_settings: TrustedRelayConfig,
30    /// Configuration for PII stripping.
31    pub pii_config: Option<PiiConfig>,
32    /// The grouping configuration.
33    #[serde(skip_serializing_if = "Option::is_none")]
34    pub grouping_config: Option<Value>,
35    /// Configuration for filter rules.
36    #[serde(skip_serializing_if = "ProjectFiltersConfig::is_empty")]
37    pub filter_settings: ProjectFiltersConfig,
38    /// Configuration for data scrubbers.
39    #[serde(skip_serializing_if = "DataScrubbingConfig::is_disabled")]
40    pub datascrubbing_settings: DataScrubbingConfig,
41    /// Maximum event retention for the organization.
42    #[serde(skip_serializing_if = "Option::is_none")]
43    pub event_retention: Option<u16>,
44    /// Maximum sampled event retention for the organization.
45    #[serde(skip_serializing_if = "Option::is_none")]
46    pub downsampled_event_retention: Option<u16>,
47    /// Retention settings for different products.
48    #[serde(default, skip_serializing_if = "RetentionsConfig::is_empty")]
49    pub retentions: RetentionsConfig,
50    /// Trimming settings for different products.
51    #[serde(default, skip_serializing_if = "TrimmingConfigs::is_empty")]
52    pub trimming: TrimmingConfigs,
53    /// Usage quotas for this project.
54    #[serde(skip_serializing_if = "Vec::is_empty")]
55    pub quotas: Vec<Quota>,
56    /// Configuration for sampling traces, if not present there will be no sampling.
57    #[serde(alias = "dynamicSampling", skip_serializing_if = "Option::is_none")]
58    pub sampling: Option<ErrorBoundary<SamplingConfig>>,
59    /// Configuration for measurements.
60    /// NOTE: do not access directly, use [`relay_event_normalization::CombinedMeasurementsConfig`].
61    #[serde(skip_serializing_if = "Option::is_none")]
62    pub measurements: Option<MeasurementsConfig>,
63    /// Configuration for operation breakdown. Will be emitted only if present.
64    #[serde(skip_serializing_if = "Option::is_none")]
65    pub breakdowns_v2: Option<BreakdownsConfig>,
66    /// Configuration for performance score calculations. Will be emitted only if present.
67    #[serde(skip_serializing_if = "Option::is_none")]
68    pub performance_score: Option<PerformanceScoreConfig>,
69    /// Configuration for extracting metrics from sessions.
70    #[serde(skip_serializing_if = "SessionMetricsConfig::is_disabled")]
71    pub session_metrics: SessionMetricsConfig,
72    /// Configuration for generic metrics extraction from all data categories.
73    #[serde(default, skip_serializing_if = "skip_metrics_extraction")]
74    pub metric_extraction: ErrorBoundary<MetricExtractionConfig>,
75    /// Rules for applying metrics tags depending on the event's content.
76    #[serde(skip_serializing_if = "Vec::is_empty")]
77    pub metric_conditional_tagging: Vec<TaggingRule>,
78    /// Exposable features enabled for this project.
79    #[serde(skip_serializing_if = "FeatureSet::is_empty")]
80    pub features: FeatureSet,
81    /// Transaction renaming rules.
82    #[serde(skip_serializing_if = "Vec::is_empty")]
83    pub tx_name_rules: Vec<TransactionNameRule>,
84    /// Whether or not a project is ready to mark all URL transactions as "sanitized".
85    #[serde(skip_serializing_if = "is_false")]
86    pub tx_name_ready: bool,
87    /// Span description renaming rules.
88    ///
89    /// These are currently not used by Relay, and only here to be forwarded to old
90    /// relays that might still need them.
91    #[serde(skip_serializing_if = "Option::is_none")]
92    pub span_description_rules: Option<Vec<SpanDescriptionRule>>,
93}
94
95impl ProjectConfig {
96    /// Validates fields in this project config and removes values that are partially invalid.
97    pub fn sanitize(&mut self, report_errors: bool) {
98        self.remove_invalid_quotas(report_errors);
99
100        metrics::convert_conditional_tagging(self);
101        defaults::add_span_metrics(self);
102
103        if let Some(ErrorBoundary::Ok(ref mut sampling_config)) = self.sampling {
104            sampling_config.normalize();
105        }
106
107        for flag in GRADUATED_FEATURE_FLAGS {
108            self.features.0.insert(*flag);
109        }
110    }
111
112    fn remove_invalid_quotas(&mut self, report_errors: bool) {
113        let invalid_quotas: Vec<_> = self.quotas.extract_if(.., |q| !q.is_valid()).collect();
114        if report_errors {
115            if !invalid_quotas.is_empty() {
116                {
117                    relay_log::warn!(
118                        invalid_quotas = ?invalid_quotas,
119                        "Found an invalid quota definition",
120                    );
121                }
122            }
123            // Check if indexed and non-indexed are double-counting towards the same ID.
124            // This is probably not intended behavior.
125            for quota in &self.quotas {
126                if let Some(id) = quota.id.as_deref() {
127                    for category in quota.categories.iter() {
128                        if let Some(indexed) = category.index_category()
129                            && quota.categories.contains(&indexed)
130                        {
131                            relay_log::error!(
132                                tags.id = id,
133                                "Categories {category} and {indexed} share the same quota ID. This will double-count items.",
134                            );
135                        }
136                    }
137                }
138            }
139        }
140    }
141}
142
143impl Default for ProjectConfig {
144    fn default() -> Self {
145        ProjectConfig {
146            allowed_domains: vec!["*".to_owned()],
147            trusted_relays: vec![],
148            trusted_relay_settings: TrustedRelayConfig::default(),
149            pii_config: None,
150            grouping_config: None,
151            filter_settings: ProjectFiltersConfig::default(),
152            datascrubbing_settings: DataScrubbingConfig::default(),
153            event_retention: None,
154            downsampled_event_retention: None,
155            retentions: Default::default(),
156            trimming: Default::default(),
157            quotas: Vec::new(),
158            sampling: None,
159            measurements: None,
160            breakdowns_v2: None,
161            performance_score: Default::default(),
162            session_metrics: SessionMetricsConfig::default(),
163            metric_extraction: Default::default(),
164            metric_conditional_tagging: Vec::new(),
165            features: Default::default(),
166            tx_name_rules: Vec::new(),
167            tx_name_ready: false,
168            span_description_rules: None,
169        }
170    }
171}
172
173fn skip_metrics_extraction(boundary: &ErrorBoundary<MetricExtractionConfig>) -> bool {
174    match boundary {
175        ErrorBoundary::Err(_) => true,
176        ErrorBoundary::Ok(config) => !config.is_enabled(),
177    }
178}
179
180/// Subset of [`ProjectConfig`] that is passed to external Relays.
181///
182/// For documentation of the fields, see [`ProjectConfig`].
183#[allow(missing_docs)]
184#[derive(Debug, Serialize)]
185#[serde(rename_all = "camelCase", remote = "ProjectConfig")]
186pub struct LimitedProjectConfig {
187    pub allowed_domains: Vec<String>,
188    pub trusted_relays: Vec<PublicKey>,
189    pub pii_config: Option<PiiConfig>,
190    #[serde(skip_serializing_if = "ProjectFiltersConfig::is_empty")]
191    pub filter_settings: ProjectFiltersConfig,
192    #[serde(skip_serializing_if = "DataScrubbingConfig::is_disabled")]
193    pub datascrubbing_settings: DataScrubbingConfig,
194    #[serde(skip_serializing_if = "TrimmingConfigs::is_empty")]
195    pub trimming: TrimmingConfigs,
196    #[serde(skip_serializing_if = "SessionMetricsConfig::is_disabled")]
197    pub session_metrics: SessionMetricsConfig,
198    #[serde(skip_serializing_if = "Vec::is_empty")]
199    pub metric_conditional_tagging: Vec<TaggingRule>,
200    #[serde(skip_serializing_if = "Option::is_none")]
201    pub measurements: Option<MeasurementsConfig>,
202    #[serde(skip_serializing_if = "Option::is_none")]
203    pub breakdowns_v2: Option<BreakdownsConfig>,
204    #[serde(skip_serializing_if = "Option::is_none")]
205    pub performance_score: Option<PerformanceScoreConfig>,
206    #[serde(skip_serializing_if = "FeatureSet::is_empty")]
207    pub features: FeatureSet,
208    #[serde(skip_serializing_if = "Vec::is_empty")]
209    pub tx_name_rules: Vec<TransactionNameRule>,
210    /// Whether or not a project is ready to mark all URL transactions as "sanitized".
211    #[serde(skip_serializing_if = "is_false")]
212    pub tx_name_ready: bool,
213    /// Span description renaming rules.
214    ///
215    /// These are currently not used by Relay, and only here to be forwarded to old
216    /// relays that might still need them.
217    #[serde(skip_serializing_if = "Option::is_none")]
218    pub span_description_rules: Option<Vec<SpanDescriptionRule>>,
219}
220
221/// Per-Category settings for retention policy.
222#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
223pub struct RetentionConfig {
224    /// Standard / full fidelity retention policy in days.
225    pub standard: u16,
226    /// Downsampled retention policy in days.
227    #[serde(skip_serializing_if = "Option::is_none")]
228    pub downsampled: Option<u16>,
229}
230
231/// Settings for retention policy.
232#[derive(Debug, Clone, Serialize, Deserialize, Default)]
233#[serde(rename_all = "camelCase")]
234pub struct RetentionsConfig {
235    /// Retention settings for logs.
236    #[serde(skip_serializing_if = "Option::is_none")]
237    pub log: Option<RetentionConfig>,
238    /// Retention settings for spans.
239    #[serde(skip_serializing_if = "Option::is_none")]
240    pub span: Option<RetentionConfig>,
241    /// Retention settings for metrics.
242    #[serde(skip_serializing_if = "Option::is_none")]
243    pub trace_metric: Option<RetentionConfig>,
244    /// Retention settings for attachments.
245    #[serde(skip_serializing_if = "Option::is_none")]
246    pub trace_attachment: Option<RetentionConfig>,
247}
248
249impl RetentionsConfig {
250    fn is_empty(&self) -> bool {
251        let Self {
252            log,
253            span,
254            trace_metric,
255            trace_attachment,
256        } = self;
257
258        log.is_none() && span.is_none() && trace_metric.is_none() && trace_attachment.is_none()
259    }
260}
261
262/// Per-category settings for item trimming.
263#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
264#[serde(rename_all = "camelCase")]
265pub struct TrimmingConfig {
266    /// The maximum size in bytes above which an item should be trimmed.
267    pub max_size: u32,
268}
269
270/// Settings for item trimming.
271#[derive(Debug, Clone, Serialize, Deserialize, Default)]
272#[serde(rename_all = "camelCase")]
273pub struct TrimmingConfigs {
274    /// Trimming settings for spans.
275    #[serde(skip_serializing_if = "Option::is_none")]
276    pub span: Option<TrimmingConfig>,
277}
278
279impl TrimmingConfigs {
280    fn is_empty(&self) -> bool {
281        let Self { span } = self;
282        span.is_none()
283    }
284}
285
286fn is_false(value: &bool) -> bool {
287    !*value
288}
289
290#[cfg(test)]
291mod tests {
292    use super::*;
293
294    #[test]
295    fn graduated_feature_flag_gets_inserted() {
296        let mut project_config = ProjectConfig::default();
297        for feature in GRADUATED_FEATURE_FLAGS {
298            assert!(!project_config.features.has(*feature));
299        }
300
301        project_config.sanitize(false);
302
303        for feature in GRADUATED_FEATURE_FLAGS {
304            assert!(project_config.features.has(*feature));
305        }
306    }
307}
relay_dynamic_config/project.rs

relay_dynamic_config/
project.rs
