relay_dynamic_config/
feature.rs

1use std::collections::BTreeSet;
2
3use serde::{Deserialize, Serialize};
4
5/// Feature flags of graduated features are no longer sent by sentry, but Relay needs to insert them
6/// for outdated downstream Relays that may still rely on the feature flag.
7pub const GRADUATED_FEATURE_FLAGS: &[Feature] = &[
8    Feature::UserReportV2Ingest,
9    Feature::IngestUnsampledProfiles,
10    Feature::DeprecatedProfiling,
11    Feature::DeprecatedOtelTracesEndpoint,
12    Feature::DeprecatedOtelLogsEndpoint,
13    Feature::DeprecatedExtractSpansFromEvent,
14    Feature::DeprecatedStandaloneSpanIngestion,
15    Feature::DeprecatedSpanV2ExperimentalProcessing,
16];
17
18/// Features exposed by project config.
19#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
20pub enum Feature {
21    /// Enables ingestion of Session Replays (Replay Recordings and Replay Events).
22    ///
23    /// Serialized as `organizations:session-replay`.
24    #[serde(rename = "organizations:session-replay")]
25    SessionReplay,
26    /// Enables data scrubbing of replay recording payloads.
27    ///
28    /// Serialized as `organizations:session-replay-recording-scrubbing`.
29    #[serde(rename = "organizations:session-replay-recording-scrubbing")]
30    SessionReplayRecordingScrubbing,
31    /// Disables select organizations from processing mobile replay events.
32    ///
33    /// Serialized as `organizations:session-replay-video-disabled`.
34    #[serde(rename = "organizations:session-replay-video-disabled")]
35    SessionReplayVideoDisabled,
36    /// Enable playstation crash dump ingestion via the `/playstation/` endpoint.
37    ///
38    /// Serialized as `organizations:relay-playstation-ingestion`.
39    #[serde(rename = "organizations:relay-playstation-ingestion")]
40    PlaystationIngestion,
41    /// Discard transactions in a spans-only world.
42    ///
43    /// Serialized as `projects:discard-transaction`.
44    #[serde(rename = "projects:discard-transaction")]
45    DiscardTransaction,
46    /// Enable continuous profiling.
47    ///
48    /// Serialized as `organizations:continuous-profiling`.
49    #[serde(rename = "organizations:continuous-profiling")]
50    ContinuousProfiling,
51    /// Enable Perfetto binary trace processing for continuous profiling.
52    ///
53    /// When enabled, compound profile chunk items with `content_type: "perfetto"` are
54    /// expanded from binary Perfetto format into the Sample v2 JSON format.
55    ///
56    /// Serialized as `organizations:continuous-profiling-perfetto`.
57    #[serde(rename = "organizations:continuous-profiling-perfetto")]
58    ContinuousProfilingPerfetto,
59    /// Enable log ingestion for our log product (this is not internal logging).
60    ///
61    /// Serialized as `organizations:ourlogs-ingestion`.
62    #[serde(rename = "organizations:ourlogs-ingestion")]
63    OurLogsIngestion,
64    /// Enable trace metric ingestion for our trace metric product.
65    ///
66    /// Serialized as `organizations:tracemetrics-ingestion`.
67    #[serde(rename = "organizations:tracemetrics-ingestion")]
68    TraceMetricsIngestion,
69    /// Enable browser report ingestion.
70    ///
71    /// Serialized as `organizations:browser-report-ingestion`.
72    #[serde(rename = "organizations:browser-report-ingestion")]
73    BrowserReportIngestion,
74    /// Project-level opt-in for JSON attribute expansion, set via project settings.
75    ///
76    /// Serialized as `projects:relay-automatic-json-expansion`.
77    #[serde(rename = "projects:relay-automatic-json-expansion")]
78    ProjectAutomaticJsonExpansion,
79    /// This feature has graduated ant is hard-coded for external Relays.
80    #[doc(hidden)]
81    #[serde(rename = "projects:profiling-ingest-unsampled-profiles")]
82    IngestUnsampledProfiles,
83    /// This feature has graduated and is hard-coded for external Relays.
84    #[doc(hidden)]
85    #[serde(rename = "organizations:user-feedback-ingest")]
86    UserReportV2Ingest,
87    #[doc(hidden)]
88    #[serde(rename = "organizations:view-hierarchy-scrubbing")]
89    ViewHierarchyScrubbing,
90    /// Detect performance issues in the new standalone spans pipeline instead of on transactions.
91    #[serde(rename = "organizations:performance-issues-spans")]
92    PerformanceIssuesSpans,
93    /// Enable the experimental Span Attachment subset of the Span V2 processing pipeline in Relay.
94    #[serde(rename = "projects:span-v2-attachment-processing")]
95    SpanV2AttachmentProcessing,
96    /// Enable the experimental Trace Attachment pipeline in Relay.
97    #[serde(rename = "projects:trace-attachment-processing")]
98    TraceAttachmentProcessing,
99    /// Upload non-prosperodmp playstation attachments via the upload endpoint.
100    #[serde(rename = "projects:relay-playstation-uploads")]
101    PlaystationUploads,
102    /// Enable Nintendo event rewrite.
103    #[serde(rename = "projects:relay-nintendo-event-rewrite")]
104    NintendoEventRewrite,
105    /// Stream minidumps to objectstore.
106    #[serde(rename = "projects:relay-minidump-uploads")]
107    MinidumpUploads,
108    /// Split an NVIDIA GPU crash dump (`.nv-gpudmp`) off a minidump upload into its
109    /// own event.
110    #[serde(rename = "organizations:gpu-crash-symbolication")]
111    NvGpuCrashSplit,
112    /// Enable resumable uploads to objectstore.
113    #[serde(rename = "projects:resumable-uploads")]
114    ResumableUpload,
115    /// Enables OTLP spans to use the Span V2 processing pipeline in Relay.
116    ///
117    /// This is now the default behaviour of Relay.
118    #[serde(rename = "organizations:span-v2-otlp-processing")]
119    DeprecatedSpanV2OtlpProcessing,
120    /// This feature has deprecated and is kept for external Relays.
121    #[doc(hidden)]
122    #[serde(rename = "projects:span-metrics-extraction")]
123    DeprecatedExtractCommonSpanMetricsFromEvent,
124    /// This feature has been deprecated and is kept for external Relays.
125    #[doc(hidden)]
126    #[serde(rename = "projects:span-metrics-extraction-addons")]
127    DeprecatedExtractAddonsSpanMetricsFromEvent,
128    /// This feature has graduated and is hard-coded for external Relays.
129    #[doc(hidden)]
130    #[serde(rename = "organizations:indexed-spans-extraction")]
131    DeprecatedExtractSpansFromEvent,
132    /// Enable standalone span ingestion via the `/traces/` OTel endpoint.
133    ///
134    /// This feature has graduated and is hard-coded for external Relays.
135    #[doc(hidden)]
136    #[serde(rename = "organizations:relay-otlp-traces-endpoint")]
137    DeprecatedOtelTracesEndpoint,
138    /// Enable logs ingestion via the `/logs/` OTel endpoint.
139    ///
140    /// This feature has graduated and is hard-coded for external Relays.
141    #[doc(hidden)]
142    #[serde(rename = "organizations:relay-otel-logs-endpoint")]
143    DeprecatedOtelLogsEndpoint,
144    /// Enable standalone span ingestion.
145    ///
146    /// Serialized as `organizations:standalone-span-ingestion`.
147    #[doc(hidden)]
148    #[serde(rename = "organizations:standalone-span-ingestion")]
149    DeprecatedStandaloneSpanIngestion,
150    /// Enable processing profiles.
151    ///
152    /// This feature has graduated and is hard-coded for external Relays.
153    #[doc(hidden)]
154    #[serde(rename = "organizations:profiling")]
155    DeprecatedProfiling,
156    /// Enables the experimental Span V2 processing pipeline in Relay.
157    ///
158    /// This feature has graduated.
159    #[doc(hidden)]
160    #[serde(rename = "projects:span-v2-experimental-processing")]
161    DeprecatedSpanV2ExperimentalProcessing,
162
163    /// Forward compatibility.
164    #[doc(hidden)]
165    #[serde(other)]
166    Unknown,
167}
168
169/// A set of [`Feature`]s.
170#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]
171pub struct FeatureSet(pub BTreeSet<Feature>);
172
173impl FeatureSet {
174    /// Returns `true` if the set of features is empty.
175    pub fn is_empty(&self) -> bool {
176        self.0.is_empty()
177    }
178
179    /// Returns `true` if the given feature is in the set.
180    pub fn has(&self, feature: Feature) -> bool {
181        self.0.contains(&feature)
182    }
183}
184
185impl FromIterator<Feature> for FeatureSet {
186    fn from_iter<T: IntoIterator<Item = Feature>>(iter: T) -> Self {
187        Self(BTreeSet::from_iter(iter))
188    }
189}
190
191impl<'de> Deserialize<'de> for FeatureSet {
192    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
193    where
194        D: serde::Deserializer<'de>,
195    {
196        let mut set = BTreeSet::<Feature>::deserialize(deserializer)?;
197        set.remove(&Feature::Unknown);
198        Ok(Self(set))
199    }
200}
201
202#[cfg(test)]
203mod tests {
204    use super::*;
205
206    #[test]
207    fn roundtrip() {
208        let features: FeatureSet =
209            serde_json::from_str(r#"["organizations:session-replay", "foo"]"#).unwrap();
210        assert_eq!(
211            &features,
212            &FeatureSet(BTreeSet::from([Feature::SessionReplay]))
213        );
214        assert_eq!(
215            serde_json::to_string(&features).unwrap(),
216            r#"["organizations:session-replay"]"#
217        );
218    }
219
220    #[test]
221    fn test_continuous_profiling_perfetto_serde() {
222        // Verify the serialized name matches what Sentry's backend sends.
223        let serialized = serde_json::to_string(&Feature::ContinuousProfilingPerfetto).unwrap();
224        assert_eq!(
225            serialized,
226            r#""organizations:continuous-profiling-perfetto""#
227        );
228
229        let deserialized: Feature =
230            serde_json::from_str(r#""organizations:continuous-profiling-perfetto""#).unwrap();
231        assert_eq!(deserialized, Feature::ContinuousProfilingPerfetto);
232    }
233}
relay_dynamic_config/feature.rs

relay_dynamic_config/
feature.rs
