1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
use std::collections::BTreeSet;
use serde::{Deserialize, Serialize};
/// Feature flags of graduated features are no longer sent by sentry, but Relay needs to insert them
/// for outdated downstream Relays that may still rely on the feature flag.
pub const GRADUATED_FEATURE_FLAGS: &[Feature] = &[
Feature::UserReportV2Ingest,
Feature::IngestUnsampledProfiles,
Feature::ScrubMongoDbDescriptions,
];
/// Features exposed by project config.
#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub enum Feature {
/// Enables ingestion of Session Replays (Replay Recordings and Replay Events).
///
/// Serialized as `organizations:session-replay`.
#[serde(rename = "organizations:session-replay")]
SessionReplay,
/// Enables data scrubbing of replay recording payloads.
///
/// Serialized as `organizations:session-replay-recording-scrubbing`.
#[serde(rename = "organizations:session-replay-recording-scrubbing")]
SessionReplayRecordingScrubbing,
/// Enables combining session replay envelope items (Replay Recordings and Replay Events).
/// into one Kafka message.
///
/// Serialized as `organizations:session-replay-combined-envelope-items`.
#[serde(rename = "organizations:session-replay-combined-envelope-items")]
SessionReplayCombinedEnvelopeItems,
/// Disables select organizations from processing mobile replay events.
///
/// Serialized as `organizations:session-replay-video-disabled`.
#[serde(rename = "organizations:session-replay-video-disabled")]
SessionReplayVideoDisabled,
/// Enables device.class synthesis
///
/// Enables device.class tag synthesis on mobile events.
///
/// Serialized as `organizations:device-class-synthesis`.
#[serde(rename = "organizations:device-class-synthesis")]
DeviceClassSynthesis,
/// Allow ingestion of metrics in the "custom" namespace.
///
/// Serialized as `organizations:custom-metrics`.
#[serde(rename = "organizations:custom-metrics")]
CustomMetrics,
/// Enable processing profiles.
///
/// Serialized as `organizations:profiling`.
#[serde(rename = "organizations:profiling")]
Profiling,
/// Enable standalone span ingestion.
///
/// Serialized as `organizations:standalone-span-ingestion`.
#[serde(rename = "organizations:standalone-span-ingestion")]
StandaloneSpanIngestion,
/// Enable standalone span ingestion via the `/traces/` OTel endpoint.
///
/// Serialized as `projects:relay-otel-endpoint`.
#[serde(rename = "projects:relay-otel-endpoint")]
OtelEndpoint,
/// Discard transactions in a spans-only world.
///
/// Serialized as `projects:discard-transaction`.
#[serde(rename = "projects:discard-transaction")]
DiscardTransaction,
/// Enable continuous profiling.
///
/// Serialized as `organizations:continuous-profiling`.
#[serde(rename = "organizations:continuous-profiling")]
ContinuousProfiling,
/// Enabled for beta orgs
///
/// Serialized as `organizations:continuous-profiling-beta`.
#[serde(rename = "organizations:continuous-profiling-beta")]
ContinuousProfilingBeta,
/// Enabled when only beta orgs are allowed to send continuous profiles.
///
/// Serialized as `organizations:continuous-profiling-beta-ingest`.
#[serde(rename = "organizations:continuous-profiling-beta-ingest")]
ContinuousProfilingBetaIngest,
/// Enables metric extraction from spans for common modules.
///
/// Serialized as `projects:span-metrics-extraction`.
#[serde(rename = "projects:span-metrics-extraction")]
ExtractCommonSpanMetricsFromEvent,
/// Enables metric extraction from spans for addon modules.
///
/// Serialized as `projects:span-metrics-extraction-addons`.
#[serde(rename = "projects:span-metrics-extraction-addons")]
ExtractAddonsSpanMetricsFromEvent,
/// When enabled, spans will be extracted from a transaction.
///
/// Serialized as `organizations:indexed-spans-extraction`.
#[serde(rename = "organizations:indexed-spans-extraction")]
ExtractSpansFromEvent,
/// Indicate if the EAP consumers should ingest a span.
///
/// Serialized as `organizations:ingest-spans-in-eap`
#[serde(rename = "organizations:ingest-spans-in-eap")]
IngestSpansInEap,
/// This feature has graduated and is hard-coded for external Relays.
#[doc(hidden)]
#[serde(rename = "projects:profiling-ingest-unsampled-profiles")]
IngestUnsampledProfiles,
/// This feature has graduated and is hard-coded for external Relays.
#[doc(hidden)]
#[serde(rename = "organizations:user-feedback-ingest")]
UserReportV2Ingest,
/// This feature has graduated and is hard-coded for external Relays.
#[doc(hidden)]
#[serde(rename = "organizations:performance-queries-mongodb-extraction")]
ScrubMongoDbDescriptions,
/// Forward compatibility.
#[doc(hidden)]
#[serde(other)]
Unknown,
}
/// A set of [`Feature`]s.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]
pub struct FeatureSet(pub BTreeSet<Feature>);
impl FeatureSet {
/// Returns `true` if the set of features is empty.
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
/// Returns `true` if the given feature is in the set.
pub fn has(&self, feature: Feature) -> bool {
self.0.contains(&feature)
}
/// Returns `true` if any spans are produced for this project.
pub fn produces_spans(&self) -> bool {
self.has(Feature::ExtractSpansFromEvent)
|| self.has(Feature::StandaloneSpanIngestion)
|| self.has(Feature::ExtractCommonSpanMetricsFromEvent)
}
}
impl FromIterator<Feature> for FeatureSet {
fn from_iter<T: IntoIterator<Item = Feature>>(iter: T) -> Self {
Self(BTreeSet::from_iter(iter))
}
}
impl<'de> Deserialize<'de> for FeatureSet {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let mut set = BTreeSet::<Feature>::deserialize(deserializer)?;
set.remove(&Feature::Unknown);
Ok(Self(set))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn roundtrip() {
let features: FeatureSet =
serde_json::from_str(r#"["organizations:session-replay", "foo"]"#).unwrap();
assert_eq!(
&features,
&FeatureSet(BTreeSet::from([Feature::SessionReplay]))
);
assert_eq!(
serde_json::to_string(&features).unwrap(),
r#"["organizations:session-replay"]"#
);
}
}