feat(spans): Convert Span V1 to Span V2 (#5139)

This conversion will eventually be used to convert Span V1 payloads
early in the pipeline. Short term it will be needed to convert `SpanV1
-> SpanV2 -> CompatSpan` at the end of processing so we can migrate the
span consumer (sentry-side) to the new schema.

ref: INGEST-531

Author: jjbayer

.gitignore

@@ -17,6 +17,7 @@ target
 
 # Editors
 /.idea/
+/*.sln
 .DS_Store
 
 # NPM utilities for building docs

relay-event-normalization/src/event.rs

@@ -348,7 +348,7 @@ fn normalize(event: &mut Event, meta: &mut Meta, config: &NormalizationConfig) {
     }
 
     if config.performance_issues_spans && event.ty.value() == Some(&EventType::Transaction) {
-        event._performance_issues_spans = Annotated::new(true);
+        event.performance_issues_spans = Annotated::new(true);
     }
 
     if config.enrich_spans {

relay-event-normalization/src/normalize/mod.rs

@@ -2074,7 +2074,7 @@ mod tests {
                 platform: ~,
                 was_transaction: ~,
                 kind: ~,
-                _performance_issues_spans: ~,
+                performance_issues_spans: ~,
                 other: {},
             },
         ]
@@ -2122,7 +2122,7 @@ mod tests {
                 platform: ~,
                 was_transaction: ~,
                 kind: ~,
-                _performance_issues_spans: ~,
+                performance_issues_spans: ~,
                 other: {},
             },
         ]
@@ -2170,7 +2170,7 @@ mod tests {
                 platform: ~,
                 was_transaction: ~,
                 kind: ~,
-                _performance_issues_spans: ~,
+                performance_issues_spans: ~,
                 other: {},
             },
         ]

relay-event-schema/src/protocol/attributes.rs

@@ -42,6 +42,15 @@ impl fmt::Debug for Attribute {
     }
 }
 
+impl From<AttributeValue> for Attribute {
+    fn from(value: AttributeValue) -> Self {
+        Self {
+            value,
+            other: Default::default(),
+        }
+    }
+}
+
 #[derive(Debug, Clone, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
 pub struct AttributeValue {
     #[metastructure(field = "type", required = true, trim = false, pii = "false")]
@@ -197,7 +206,7 @@ impl Attributes {
         String: Borrow<Q>,
         Q: Ord + ?Sized,
     {
-        self.get_attribute(key)?.value.value.value()
+        self.get_annotated_value(key)?.value()
     }
 
     /// Returns the attribute with the given key.
@@ -209,8 +218,17 @@ impl Attributes {
         self.0.get(key)?.value()
     }
 
+    /// Returns the attribute value as annotated.
+    pub fn get_annotated_value<Q>(&self, key: &Q) -> Option<&Annotated<Value>>
+    where
+        String: Borrow<Q>,
+        Q: Ord + ?Sized,
+    {
+        Some(&self.0.get(key)?.value()?.value.value)
+    }
+
     /// Inserts an attribute with the given value into this collection.
-    pub fn insert<V: Into<AttributeValue>>(&mut self, key: String, value: V) {
+    pub fn insert<K: Into<String>, V: Into<AttributeValue>>(&mut self, key: K, value: V) {
         fn inner(slf: &mut Attributes, key: String, value: AttributeValue) {
             let attribute = Annotated::new(Attribute {
                 value,
@@ -220,7 +238,7 @@ impl Attributes {
         }
         let value = value.into();
         if !value.value.is_empty() {
-            inner(self, key, value);
+            inner(self, key.into(), value);
         }
     }
 

relay-event-schema/src/protocol/event.rs

@@ -496,8 +496,12 @@ pub struct Event {
     ///
     /// When the flag is set to true, this transaction event will be skipped for performance issue
     /// detection in favor of the spans pipeline.
-    #[metastructure(skip_serialization = "empty", trim = false)]
-    pub _performance_issues_spans: Annotated<bool>,
+    #[metastructure(
+        field = "_performance_issues_spans",
+        skip_serialization = "empty",
+        trim = false
+    )]
+    pub performance_issues_spans: Annotated<bool>,
 
     /// Additional arbitrary fields for forwards compatibility.
     #[metastructure(additional_properties, pii = "true")]

relay-event-schema/src/protocol/span.rs

@@ -128,8 +128,12 @@ pub struct Span {
     /// is a root (segment) instead of the transaction event.
     ///
     /// Only set on root spans extracted from transactions.
-    #[metastructure(skip_serialization = "empty", trim = false)]
-    pub _performance_issues_spans: Annotated<bool>,
+    #[metastructure(
+        field = "_performance_issues_spans",
+        skip_serialization = "empty",
+        trim = false
+    )]
+    pub performance_issues_spans: Annotated<bool>,
 
     // TODO remove retain when the api stabilizes
     /// Additional arbitrary fields for forwards compatibility.

relay-event-schema/src/protocol/span/compat.rs

@@ -20,6 +20,9 @@ pub struct CompatSpan {
     pub segment_id: Annotated<String>,
     pub start_timestamp_ms: Annotated<u64>, // TODO: remove from kafka schema, no longer used in consumer
     pub start_timestamp_precise: Annotated<Timestamp>,
+
+    #[metastructure(field = "_performance_issues_spans")]
+    pub performance_issues_spans: Annotated<bool>, // TODO: add to Kafka schema?
 }
 
 impl TryFrom<SpanV2> for CompatSpan {
@@ -73,13 +76,20 @@ impl TryFrom<SpanV2> for CompatSpan {
             }
 
             if let Some(segment_id) = attributes
-                .get_value("sentry.segment.id") // TODO: EAP expects `sentry.segment_id`, double write this somewhere.
+                .get_value("sentry.segment.id")
                 .and_then(Value::as_str)
             {
                 compat_span.segment_id = Annotated::from(segment_id.to_owned());
             }
+
+            if let Some(Value::Bool(b)) =
+                attributes.get_value("sentry._internal.performance_issues_spans")
+            {
+                compat_span.performance_issues_spans = Annotated::new(*b);
+            }
         }
 
+        // FIXME: preserve _meta everywhere (see a test failure).
         compat_span.span_v2 = span_v2;
         Ok(compat_span)
     }
@@ -143,6 +153,10 @@ mod tests {
                 "sentry.segment.name": {
                     "value": "my 1st transaction",
                     "type": "string"
+                },
+                "sentry._internal.performance_issues_spans": {
+                    "value": true,
+                    "type": "bool"
                 }
             }
         }"#;
@@ -165,6 +179,10 @@ mod tests {
               "type": "string",
               "value": "Chrome"
             },
+            "sentry._internal.performance_issues_spans": {
+              "type": "bool",
+              "value": true
+            },
             "sentry.description": {
               "type": "string",
               "value": "mydescription"
@@ -204,6 +222,7 @@ mod tests {
           },
           "data": {
             "browser.name": "Chrome",
+            "sentry._internal.performance_issues_spans": true,
             "sentry.description": "mydescription",
             "sentry.environment": "prod",
             "sentry.op": "myop",
@@ -220,7 +239,8 @@ mod tests {
           "profile_id": "a0aaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
           "segment_id": "FA90FDEAD5F74052",
           "start_timestamp_ms": 123000,
-          "start_timestamp_precise": 123.0
+          "start_timestamp_precise": 123.0,
+          "_performance_issues_spans": true
         }
         "###);
     }

relay-event-schema/src/protocol/span/convert.rs

@@ -17,7 +17,7 @@ impl From<&Event> for Span {
 
             measurements,
             _metrics,
-            _performance_issues_spans,
+            performance_issues_spans,
             ..
         } = event;
 
@@ -72,7 +72,7 @@ impl From<&Event> for Span {
             platform: platform.clone(),
             was_transaction: true.into(),
             kind: Default::default(),
-            _performance_issues_spans: _performance_issues_spans.clone(),
+            performance_issues_spans: performance_issues_spans.clone(),
             other: Default::default(),
         }
     }
@@ -134,7 +134,7 @@ mod tests {
         .unwrap();
 
         let span_from_event = Span::from(&event);
-        insta::assert_debug_snapshot!(span_from_event, @r#"
+        insta::assert_debug_snapshot!(span_from_event, @r###"
         Span {
             timestamp: ~,
             start_timestamp: ~,
@@ -287,9 +287,9 @@ mod tests {
             platform: "php",
             was_transaction: true,
             kind: ~,
-            _performance_issues_spans: ~,
+            performance_issues_spans: ~,
             other: {},
         }
-        "#);
+        "###);
     }
 }

relay-pii/src/snapshots/relay_pii__processor__tests__does_not_scrub_if_no_graphql.snap

@@ -109,6 +109,6 @@ Event {
     scraping_attempts: ~,
     _metrics: ~,
     _dsc: ~,
-    _performance_issues_spans: ~,
+    performance_issues_spans: ~,
     other: {},
 }

relay-pii/src/snapshots/relay_pii__processor__tests__scrub_graphql_response_data_with_variables.snap

@@ -109,6 +109,6 @@ Event {
     scraping_attempts: ~,
     _metrics: ~,
     _dsc: ~,
-    _performance_issues_spans: ~,
+    performance_issues_spans: ~,
     other: {},
 }