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

relay_dynamic_config/
feature.rs
