ref(server): introduce client name enum (#4226)

Introduces an enum which allows us to have more fine grained control
over which sdks are tagged

Author: Litarnus

relay-server/src/endpoints/common.rs

@@ -334,16 +334,12 @@ pub async fn handle_envelope(
     state: &ServiceState,
     envelope: Box<Envelope>,
 ) -> Result<Option<EventId>, BadStoreRequest> {
-    let client_name = envelope
-        .meta()
-        .client_name()
-        .filter(|name| name.starts_with("sentry") || name.starts_with("raven"))
-        .unwrap_or("proprietary");
+    let client_name = envelope.meta().client_name();
     for item in envelope.items() {
         metric!(
             histogram(RelayHistograms::EnvelopeItemSize) = item.payload().len() as u64,
             item_type = item.ty().name(),
-            sdk = client_name,
+            sdk = client_name.name(),
         )
     }
 

relay-server/src/extractors/request_meta.rs

@@ -23,7 +23,7 @@ use url::Url;
 
 use crate::extractors::{ForwardedFor, ReceivedAt};
 use crate::service::ServiceState;
-use crate::statsd::RelayCounters;
+use crate::statsd::{ClientName, RelayCounters};
 use crate::utils::ApiErrorResponse;
 
 #[derive(Debug, thiserror::Error)]
@@ -248,10 +248,11 @@ impl<D> RequestMeta<D> {
     /// Returns the name of the client that sent the event without version.
     ///
     /// If the client is not sent in standard format, this method returns `None`.
-    pub fn client_name(&self) -> Option<&str> {
-        let client = self.client()?;
-        let (name, _version) = client.split_once('/')?;
-        Some(name)
+    pub fn client_name(&self) -> ClientName {
+        self.client()
+            .and_then(|client| client.split_once('/'))
+            .map(|(client, _)| client)
+            .map_or(ClientName::Other("proprietary"), ClientName::from)
     }
 
     /// Returns the protocol version of the event payload.

relay-server/src/services/processor/event.rs

@@ -192,7 +192,7 @@ pub fn finalize<G: EventProcessing>(
             metric!(
                 counter(RelayCounters::EventTransaction) += 1,
                 source = utils::transaction_source_tag(event),
-                platform = PlatformTag::from(event.platform.as_str().unwrap_or("other")).as_str(),
+                platform = PlatformTag::from(event.platform.as_str().unwrap_or("other")).name(),
                 contains_slashes = if event.transaction.as_str().unwrap_or_default().contains('/') {
                     "true"
                 } else {
@@ -203,7 +203,7 @@ pub fn finalize<G: EventProcessing>(
             let span_count = event.spans.value().map(Vec::len).unwrap_or(0) as u64;
             metric!(
                 histogram(RelayHistograms::EventSpans) = span_count,
-                sdk = envelope.meta().client_name().unwrap_or("proprietary"),
+                sdk = envelope.meta().client_name().name(),
                 platform = event.platform.as_str().unwrap_or("other"),
             );
 
@@ -215,7 +215,7 @@ pub fn finalize<G: EventProcessing>(
             if has_otel {
                 metric!(
                     counter(RelayCounters::OpenTelemetryEvent) += 1,
-                    sdk = envelope.meta().client_name().unwrap_or("proprietary"),
+                    sdk = envelope.meta().client_name().name(),
                     platform = event.platform.as_str().unwrap_or("other"),
                 );
             }

relay-server/src/statsd.rs

@@ -935,7 +935,7 @@ pub enum PlatformTag {
 }
 
 impl PlatformTag {
-    pub fn as_str(&self) -> &str {
+    pub fn name(&self) -> &str {
         match self {
             Self::Cocoa => "cocoa",
             Self::Csharp => "csharp",
@@ -979,3 +979,84 @@ impl<S: AsRef<str>> From<S> for PlatformTag {
         }
     }
 }
+
+/// Low-cardinality SDK name that can be used as a statsd tag.
+pub enum ClientName<'a> {
+    Ruby,
+    CocoaFlutter,
+    CocoaReactNative,
+    Cocoa,
+    Dotnet,
+    AndroidReactNative,
+    AndroidJava,
+    SpringBoot,
+    JavascriptBrowser,
+    Electron,
+    NestJs,
+    NextJs,
+    Node,
+    React,
+    Vue,
+    Native,
+    Laravel,
+    Symfony,
+    Php,
+    Python,
+    Other(&'a str),
+}
+
+impl<'a> ClientName<'a> {
+    pub fn name(&self) -> &'static str {
+        match self {
+            Self::Ruby => "sentry-ruby",
+            Self::CocoaFlutter => "sentry.cocoa.flutter",
+            Self::CocoaReactNative => "sentry.cocoa.react-native",
+            Self::Cocoa => "sentry.cocoa",
+            Self::Dotnet => "sentry.dotnet",
+            Self::AndroidReactNative => "sentry.java.android.react-native",
+            Self::AndroidJava => "sentry.java.android",
+            Self::SpringBoot => "sentry.java.spring-boot.jakarta",
+            Self::JavascriptBrowser => "sentry.javascript.browser",
+            Self::Electron => "sentry.javascript.electron",
+            Self::NestJs => "sentry.javascript.nestjs",
+            Self::NextJs => "sentry.javascript.nextjs",
+            Self::Node => "sentry.javascript.node",
+            Self::React => "sentry.javascript.react",
+            Self::Vue => "sentry.javascript.vue",
+            Self::Native => "sentry.native",
+            Self::Laravel => "sentry.php.laravel",
+            Self::Symfony => "sentry.php.symfony",
+            Self::Php => "sentry.php",
+            Self::Python => "sentry.python",
+            Self::Other(_) => "other",
+        }
+    }
+}
+
+impl<'a> From<&'a str> for ClientName<'a> {
+    fn from(value: &'a str) -> Self {
+        match value {
+            "sentry-ruby" => Self::Ruby,
+            "sentry.cocoa.flutter" => Self::CocoaFlutter,
+            "sentry.cocoa.react-native" => Self::CocoaReactNative,
+            "sentry.cocoa" => Self::Cocoa,
+            "sentry.dotnet" => Self::Dotnet,
+            "sentry.java.android.react-native" => Self::AndroidReactNative,
+            "sentry.java.android" => Self::AndroidJava,
+            "sentry.java.spring-boot.jakarta" => Self::SpringBoot,
+            "sentry.javascript.browser" => Self::JavascriptBrowser,
+            "sentry.javascript.electron" => Self::Electron,
+            "sentry.javascript.nestjs" => Self::NestJs,
+            "sentry.javascript.nextjs" => Self::NextJs,
+            "sentry.javascript.node" => Self::Node,
+            "sentry.javascript.react" => Self::React,
+            "sentry.javascript.vue" => Self::Vue,
+            "sentry.native" => Self::Native,
+            "sentry.php.laravel" => Self::Laravel,
+            "sentry.php.symfony" => Self::Symfony,
+            "sentry.php" => Self::Php,
+            "sentry.python" => Self::Python,
+            other => Self::Other(other),
+        }
+    }
+}