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

relay_dynamic_config/
feature.rs
