feat(otlp): Populate sentry.platform during ingestion (#5411)

Co-authored-by: Sebastian Zivota <loewenheim@users.noreply.github.com>

Author: mjq

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Remove feature flag for Vercel Log Drain endpoint. ([#5406](https://github.com/getsentry/relay/pull/5406))
 - Add `http.request.header.cookie` to fields scrubbed by cookie rules. ([#5408](https://github.com/getsentry/relay/pull/5408))
 - Map `request_id` to `trace_id` in vercel log drain transform. ([#5333](https://github.com/getsentry/relay/pull/5333))
+- Populate `sentry.platform` during OTLP ingestion. ([#5411](https://github.com/getsentry/relay/pull/5411))
 
 **Internal**:
 

Cargo.lock

@@ -143,6 +143,7 @@ multer = "3.1.0"
 num-traits = "0.2.19"
 num_cpus = "1.17.0"
 objectstore-client = "0.0.11"
+opentelemetry-semantic-conventions = { version = "0.31.0" }
 opentelemetry-proto = { version = "0.30.0", default-features = false }
 papaya = "0.2.3"
 parking_lot = "0.12.5"

Cargo.toml

@@ -19,6 +19,7 @@ opentelemetry-proto = { workspace = true, features = [
     "trace",
     "logs",
 ] }
+opentelemetry-semantic-conventions = { workspace = true }
 relay-event-schema = { workspace = true }
 relay-protocol = { workspace = true }
 serde_json = { workspace = true }

relay-otel/Cargo.toml

@@ -9,10 +9,12 @@
     html_favicon_url = "https://raw.githubusercontent.com/getsentry/relay/master/artwork/relay-icon.png"
 )]
 
+use opentelemetry_proto::tonic::common::v1::any_value;
 use opentelemetry_proto::tonic::{
     common::v1::{InstrumentationScope, any_value::Value as OtelValue},
     resource::v1::Resource,
 };
+use opentelemetry_semantic_conventions::attribute as otel_semconv;
 use relay_event_schema::protocol::{Attribute, AttributeType, Attributes};
 use relay_protocol::{Annotated, Value};
 
@@ -129,6 +131,32 @@ pub fn otel_scope_into_attributes(
     }
 }
 
+/// Returns the telemetry language SDK from the resource, mapped into a `sentry.platform` value.
+pub fn otel_resource_to_platform(resource: &Resource) -> Option<&str> {
+    let any_value::Value::StringValue(language) = resource
+        .attributes
+        .iter()
+        .find(|attr| attr.key == otel_semconv::TELEMETRY_SDK_LANGUAGE)?
+        .value
+        .as_ref()?
+        .value
+        .as_ref()?
+    else {
+        return None;
+    };
+
+    // Smooth out some naming differences between OTel
+    // (https://opentelemetry.io/docs/specs/semconv/resource/#telemetry-sdk)
+    // and Sentry
+    // (https://github.com/getsentry/relay/blob/8e6c963cdd79dc9ba2bebc21518a3553f70feeb3/relay-event-schema/src/protocol/event.rs#L251-L253).
+    Some(match language.as_str() {
+        "dotnet" => "csharp",
+        "nodejs" => "node",
+        "webjs" => "javascript",
+        _ => language,
+    })
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -288,4 +316,34 @@ mod tests {
         }
         "#);
     }
+
+    #[test]
+    fn test_otel_resource_to_attribute_without_language() {
+        let resource = serde_json::from_value(serde_json::json!({"attributes": []})).unwrap();
+        assert_eq!(otel_resource_to_platform(&resource), None);
+    }
+
+    #[test]
+    fn test_otel_resource_to_attribute_with_unmapped_language() {
+        let resource = serde_json::from_value(serde_json::json!({
+            "attributes": [{
+                "key": "telemetry.sdk.language",
+                "value": {"stringValue": "foo"},
+            },
+        ]}))
+        .unwrap();
+        assert_eq!(otel_resource_to_platform(&resource), Some("foo"));
+    }
+
+    #[test]
+    fn test_otel_resource_to_attribute_with_mapped_language() {
+        let resource = serde_json::from_value(serde_json::json!({
+            "attributes": [{
+                "key": "telemetry.sdk.language",
+                "value": {"stringValue": "nodejs"},
+            },
+        ]}))
+        .unwrap();
+        assert_eq!(otel_resource_to_platform(&resource), Some("node"));
+    }
 }

relay-otel/src/lib.rs

@@ -7,11 +7,11 @@ use chrono::{TimeZone, Utc};
 use opentelemetry_proto::tonic::common::v1::InstrumentationScope;
 use opentelemetry_proto::tonic::common::v1::any_value::Value as OtelValue;
 use opentelemetry_proto::tonic::logs::v1::LogRecord as OtelLogRecord;
-use relay_conventions::{EVENT_NAME, ORIGIN};
+use relay_conventions::{EVENT_NAME, ORIGIN, PLATFORM};
 
 use opentelemetry_proto::tonic::resource::v1::Resource;
 use relay_event_schema::protocol::{Attributes, OurLog, OurLogLevel, SpanId, Timestamp, TraceId};
-use relay_otel::otel_value_to_attribute;
+use relay_otel::{otel_resource_to_platform, otel_value_to_attribute};
 use relay_protocol::{Annotated, Object};
 
 /// Maps OpenTelemetry severity number to Sentry log level.
@@ -82,6 +82,11 @@ pub fn otel_to_sentry_log(
     if !event_name.is_empty() {
         attribute_data.insert(EVENT_NAME, event_name.to_owned());
     }
+    if let Some(resource) = resource
+        && let Some(platform) = otel_resource_to_platform(resource)
+    {
+        attribute_data.insert(PLATFORM, platform.to_owned());
+    }
 
     relay_otel::otel_scope_into_attributes(&mut attribute_data, resource, scope);
 
@@ -186,6 +191,9 @@ mod tests {
             "attributes": [{
                 "key": "service.name",
                 "value": {"stringValue": "test-service"},
+            }, {
+              "key": "telemetry.sdk.language",
+              "value": {"stringValue": "nodejs"},
             }]
         }))
         .unwrap();
@@ -247,10 +255,18 @@ mod tests {
               "type": "string",
               "value": "test-service"
             },
+            "resource.telemetry.sdk.language": {
+              "type": "string",
+              "value": "nodejs"
+            },
             "sentry.origin": {
               "type": "string",
               "value": "auto.otlp.logs"
             },
+            "sentry.platform": {
+              "type": "string",
+              "value": "node"
+            },
             "string.attribute": {
               "type": "string",
               "value": "some string"

relay-ourlogs/src/otel_to_sentry.rs

@@ -5,9 +5,11 @@ use opentelemetry_proto::tonic::trace::v1::span::Link as OtelLink;
 use opentelemetry_proto::tonic::trace::v1::span::SpanKind as OtelSpanKind;
 use relay_conventions::IS_REMOTE;
 use relay_conventions::ORIGIN;
+use relay_conventions::PLATFORM;
 use relay_conventions::SPAN_KIND;
 use relay_conventions::STATUS_MESSAGE;
 use relay_event_schema::protocol::{Attributes, SpanKind};
+use relay_otel::otel_resource_to_platform;
 use relay_otel::otel_value_to_attribute;
 use relay_protocol::ErrorKind;
 
@@ -68,6 +70,11 @@ pub fn otel_to_sentry_span(
     relay_otel::otel_scope_into_attributes(&mut sentry_attributes, resource, scope);
 
     sentry_attributes.insert(ORIGIN, "auto.otlp.spans".to_owned());
+    if let Some(resource) = resource
+        && let Some(platform) = otel_resource_to_platform(resource)
+    {
+        sentry_attributes.insert(PLATFORM, platform.to_owned());
+    }
 
     let mut name = if name.is_empty() { None } else { Some(name) };
     for (key, value) in attributes.into_iter().flat_map(|attribute| {
@@ -264,6 +271,9 @@ mod tests {
             "attributes": [{
                 "key": "service.name",
                 "value": {"stringValue": "test-service"},
+            }, {
+              "key": "telemetry.sdk.language",
+              "value": {"stringValue": "nodejs"},
             }]
         }))
         .unwrap();
@@ -313,6 +323,10 @@ mod tests {
               "type": "string",
               "value": "test-service"
             },
+            "resource.telemetry.sdk.language": {
+              "type": "string",
+              "value": "nodejs"
+            },
             "sentry.environment": {
               "type": "string",
               "value": "test"
@@ -333,6 +347,10 @@ mod tests {
               "type": "boolean",
               "value": true
             },
+            "sentry.platform": {
+              "type": "string",
+              "value": "node"
+            },
             "sentry.sample_rate": {
               "type": "integer",
               "value": 1