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    /// This feature has graduated ant is hard-coded for external Relays.
70    #[doc(hidden)]
71    #[serde(rename = "projects:profiling-ingest-unsampled-profiles")]
72    IngestUnsampledProfiles,
73    /// This feature has graduated and is hard-coded for external Relays.
74    #[doc(hidden)]
75    #[serde(rename = "organizations:user-feedback-ingest")]
76    UserReportV2Ingest,
77    #[doc(hidden)]
78    #[serde(rename = "organizations:view-hierarchy-scrubbing")]
79    ViewHierarchyScrubbing,
80    /// Detect performance issues in the new standalone spans pipeline instead of on transactions.
81    #[serde(rename = "organizations:performance-issues-spans")]
82    PerformanceIssuesSpans,
83    /// Enable the experimental Span Attachment subset of the Span V2 processing pipeline in Relay.
84    #[serde(rename = "projects:span-v2-attachment-processing")]
85    SpanV2AttachmentProcessing,
86    /// Enable the experimental Trace Attachment pipeline in Relay.
87    #[serde(rename = "projects:trace-attachment-processing")]
88    TraceAttachmentProcessing,
89    /// Upload non-prosperodmp playstation attachments via the upload endpoint.
90    #[serde(rename = "projects:relay-playstation-uploads")]
91    PlaystationUploads,
92    /// Enable Nintendo event rewrite.
93    #[serde(rename = "projects:relay-nintendo-event-rewrite")]
94    NintendoEventRewrite,
95    /// Stream minidumps to objectstore.
96    #[serde(rename = "projects:relay-minidump-uploads")]
97    MinidumpUploads,
98    /// Split an NVIDIA GPU crash dump (`.nv-gpudmp`) off a minidump upload into its
99    /// own event.
100    #[serde(rename = "organizations:gpu-crash-symbolication")]
101    NvGpuCrashSplit,
102    /// Enables OTLP spans to use the Span V2 processing pipeline in Relay.
103    ///
104    /// This is now the default behaviour of Relay.
105    #[serde(rename = "organizations:span-v2-otlp-processing")]
106    DeprecatedSpanV2OtlpProcessing,
107    /// This feature has deprecated and is kept for external Relays.
108    #[doc(hidden)]
109    #[serde(rename = "projects:span-metrics-extraction")]
110    DeprecatedExtractCommonSpanMetricsFromEvent,
111    /// This feature has been deprecated and is kept for external Relays.
112    #[doc(hidden)]
113    #[serde(rename = "projects:span-metrics-extraction-addons")]
114    DeprecatedExtractAddonsSpanMetricsFromEvent,
115    /// This feature has graduated and is hard-coded for external Relays.
116    #[doc(hidden)]
117    #[serde(rename = "organizations:indexed-spans-extraction")]
118    DeprecatedExtractSpansFromEvent,
119    /// Enable standalone span ingestion via the `/traces/` OTel endpoint.
120    ///
121    /// This feature has graduated and is hard-coded for external Relays.
122    #[doc(hidden)]
123    #[serde(rename = "organizations:relay-otlp-traces-endpoint")]
124    DeprecatedOtelTracesEndpoint,
125    /// Enable logs ingestion via the `/logs/` OTel endpoint.
126    ///
127    /// This feature has graduated and is hard-coded for external Relays.
128    #[doc(hidden)]
129    #[serde(rename = "organizations:relay-otel-logs-endpoint")]
130    DeprecatedOtelLogsEndpoint,
131    /// Enable standalone span ingestion.
132    ///
133    /// Serialized as `organizations:standalone-span-ingestion`.
134    #[doc(hidden)]
135    #[serde(rename = "organizations:standalone-span-ingestion")]
136    DeprecatedStandaloneSpanIngestion,
137    /// Enable processing profiles.
138    ///
139    /// This feature has graduated and is hard-coded for external Relays.
140    #[doc(hidden)]
141    #[serde(rename = "organizations:profiling")]
142    DeprecatedProfiling,
143    /// Enables the experimental Span V2 processing pipeline in Relay.
144    ///
145    /// This feature has graduated.
146    #[doc(hidden)]
147    #[serde(rename = "projects:span-v2-experimental-processing")]
148    DeprecatedSpanV2ExperimentalProcessing,
149
150    /// Forward compatibility.
151    #[doc(hidden)]
152    #[serde(other)]
153    Unknown,
154}
155
156/// A set of [`Feature`]s.
157#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]
158pub struct FeatureSet(pub BTreeSet<Feature>);
159
160impl FeatureSet {
161    /// Returns `true` if the set of features is empty.
162    pub fn is_empty(&self) -> bool {
163        self.0.is_empty()
164    }
165
166    /// Returns `true` if the given feature is in the set.
167    pub fn has(&self, feature: Feature) -> bool {
168        self.0.contains(&feature)
169    }
170}
171
172impl FromIterator<Feature> for FeatureSet {
173    fn from_iter<T: IntoIterator<Item = Feature>>(iter: T) -> Self {
174        Self(BTreeSet::from_iter(iter))
175    }
176}
177
178impl<'de> Deserialize<'de> for FeatureSet {
179    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
180    where
181        D: serde::Deserializer<'de>,
182    {
183        let mut set = BTreeSet::<Feature>::deserialize(deserializer)?;
184        set.remove(&Feature::Unknown);
185        Ok(Self(set))
186    }
187}
188
189#[cfg(test)]
190mod tests {
191    use super::*;
192
193    #[test]
194    fn roundtrip() {
195        let features: FeatureSet =
196            serde_json::from_str(r#"["organizations:session-replay", "foo"]"#).unwrap();
197        assert_eq!(
198            &features,
199            &FeatureSet(BTreeSet::from([Feature::SessionReplay]))
200        );
201        assert_eq!(
202            serde_json::to_string(&features).unwrap(),
203            r#"["organizations:session-replay"]"#
204        );
205    }
206
207    #[test]
208    fn test_continuous_profiling_perfetto_serde() {
209        // Verify the serialized name matches what Sentry's backend sends.
210        let serialized = serde_json::to_string(&Feature::ContinuousProfilingPerfetto).unwrap();
211        assert_eq!(
212            serialized,
213            r#""organizations:continuous-profiling-perfetto""#
214        );
215
216        let deserialized: Feature =
217            serde_json::from_str(r#""organizations:continuous-profiling-perfetto""#).unwrap();
218        assert_eq!(deserialized, Feature::ContinuousProfilingPerfetto);
219    }
220}
relay_dynamic_config/feature.rs

relay_dynamic_config/
feature.rs
