feat(spans): Add more fields to span <-> transaction conversion #3456
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| //! This module defines bidirectional field mappings between spans and transactions. | ||
| use crate::protocol::{BrowserContext, Contexts, Event, ProfileContext, Span, TraceContext}; | ||
|
|
||
| use relay_base_schema::events::EventType; | ||
| use relay_protocol::Annotated; | ||
|
|
@@ -40,15 +40,18 @@ macro_rules! context_write_path ( | |
| ); | ||
|
|
||
| macro_rules! event_write_path( | ||
| ($event:expr, contexts browser $context_field:ident) => { | ||
| context_write_path!($event, BrowserContext, $context_field) | ||
| }; | ||
| ($event:expr, contexts trace $context_field:ident) => { | ||
| context_write_path!($event, TraceContext, $context_field) | ||
| }; | ||
| ($event:expr, contexts profile $context_field:ident) => { | ||
| context_write_path!($event, ProfileContext, $context_field) | ||
| }; | ||
| ($event:expr, $path_root:ident $($path_segment:ident)*) => { | ||
| { | ||
| write_path!($event, $path_root $($path_segment)*) | ||
| } | ||
| }; | ||
| ); | ||
|
|
@@ -63,17 +66,20 @@ macro_rules! context_value ( | |
| ); | ||
|
|
||
| macro_rules! event_value( | ||
| ($event:expr, contexts browser $context_field:ident) => { | ||
| context_value!($event, BrowserContext, $context_field) | ||
| }; | ||
| ($event:expr, contexts trace $context_field:ident) => { | ||
| context_value!($event, TraceContext, $context_field) | ||
| }; | ||
| ($event:expr, contexts profile $context_field:ident) => { | ||
| context_value!($event, ProfileContext, $context_field) | ||
| }; | ||
| ($event:expr, $path_root:ident $($path_segment:ident)*) => { | ||
| { | ||
| let value = ($event).$path_root.value(); | ||
| $( | ||
| let value = value.and_then(|value|value.$path_segment.value()); | ||
|
Comment on lines
+69
to
+82
Member
Author
There was a problem hiding this comment. Turned out I had some unused code branches here that needed to be fixed for deep access. |
||
| )* | ||
| value | ||
| } | ||
|
|
@@ -137,6 +143,7 @@ macro_rules! map_fields { | |
| map_fields!( | ||
| span._metrics_summary <=> event._metrics_summary, | ||
| span.description <=> event.transaction, | ||
| span.data.segment_name <=> event.transaction, | ||
| span.measurements <=> event.measurements, | ||
| span.platform <=> event.platform, | ||
| span.received <=> event.received, | ||
|
|
@@ -153,7 +160,9 @@ map_fields!( | |
| span.trace_id <=> event.contexts.trace.trace_id, | ||
| span.profile_id <=> event.contexts.profile.profile_id, | ||
| span.data.release <=> event.release, | ||
| span.data.environment <=> event.environment, | ||
| span.data.browser_name <=> event.contexts.browser.name, | ||
| span.data.sdk_name <=> event.client_sdk.name | ||
| ; | ||
| span.is_segment <= true, | ||
| span.was_transaction <= true | ||
|
|
@@ -165,16 +174,22 @@ map_fields!( | |
| mod tests { | ||
| use relay_protocol::Annotated; | ||
|
|
||
| use crate::protocol::SpanData; | ||
|
|
||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn roundtrip() { | ||
| let event = Annotated::<Event>::from_json( | ||
| r#"{ | ||
| "type": "transaction", | ||
| "platform": "php", | ||
| "sdk": {"name": "sentry.php"}, | ||
| "release": "[email protected]", | ||
| "environment": "prod", | ||
| "transaction": "my 1st transaction", | ||
| "contexts": { | ||
| "browser": {"name": "Chrome"}, | ||
| "profile": {"profile_id": "a0aaaaaaaaaaaaaaaaaaaaaaaaaaaaab"}, | ||
| "trace": { | ||
| "trace_id": "4C79F60C11214EB38604F4AE0781BFB2", | ||
|
|
@@ -217,7 +232,7 @@ mod tests { | |
| timestamp: ~, | ||
| start_timestamp: ~, | ||
| exclusive_time: 123.4, | ||
| description: "my 1st transaction", | ||
| op: "myop", | ||
| span_id: SpanId( | ||
| "fa90fdead5f74052", | ||
|
|
@@ -240,7 +255,7 @@ mod tests { | |
| ), | ||
| data: SpanData { | ||
| app_start_type: ~, | ||
| browser_name: "Chrome", | ||
| code_filepath: ~, | ||
| code_lineno: ~, | ||
| code_function: ~, | ||
|
|
@@ -266,11 +281,12 @@ mod tests { | |
| ai_total_tokens_used: ~, | ||
| ai_responses: ~, | ||
| thread_name: ~, | ||
| segment_name: "my 1st transaction", | ||
| ui_component_name: ~, | ||
| url_scheme: ~, | ||
| user: ~, | ||
| replay_id: ~, | ||
| sdk_name: "sentry.php", | ||
| other: {}, | ||
| }, | ||
| sentry_tags: ~, | ||
|
|
@@ -300,7 +316,7 @@ mod tests { | |
| ], | ||
| }, | ||
| ), | ||
| platform: "php", | ||
| was_transaction: true, | ||
| other: {}, | ||
| } | ||
|
|
@@ -310,6 +326,23 @@ mod tests { | |
| assert_eq!(event, roundtripped); | ||
| } | ||
|
|
||
| #[test] | ||
| fn segment_name_takes_precedence() { | ||
|
||
| let span = Span { | ||
| is_segment: true.into(), | ||
| description: "This is the description".to_owned().into(), | ||
| data: SpanData { | ||
| segment_name: "This is the segment name".to_owned().into(), | ||
| ..Default::default() | ||
| } | ||
| .into(), | ||
| ..Default::default() | ||
| }; | ||
| let event = Event::try_from(&span).unwrap(); | ||
|
|
||
| assert_eq!(event.transaction.as_str(), Some("This is the segment name")); | ||
| } | ||
|
|
||
| #[test] | ||
| fn no_empty_profile_context() { | ||
| let span = Span { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -339,11 +339,12 @@ expression: "(&event.value().unwrap().spans, metrics)" | |
| ai_total_tokens_used: ~, | ||
| ai_responses: ~, | ||
| thread_name: ~, | ||
| segment_name: ~, | ||
| ui_component_name: ~, | ||
| url_scheme: ~, | ||
| user: ~, | ||
| replay_id: ~, | ||
| sdk_name: ~, | ||
| other: {}, | ||
| }, | ||
| sentry_tags: { | ||
|
|
@@ -421,11 +422,12 @@ expression: "(&event.value().unwrap().spans, metrics)" | |
| ai_total_tokens_used: ~, | ||
| ai_responses: ~, | ||
| thread_name: ~, | ||
| segment_name: ~, | ||
| ui_component_name: ~, | ||
| url_scheme: ~, | ||
| user: ~, | ||
| replay_id: ~, | ||
| sdk_name: ~, | ||
| other: {}, | ||
| }, | ||
| sentry_tags: { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -484,7 +484,7 @@ fn normalize( | |
| .and_then(|v| v.name.value()) | ||
| { | ||
| let data = span.data.value_mut().get_or_insert_with(SpanData::default); | ||
| data.browser_name = Annotated::new(browser_name.to_owned()); | ||
| } | ||
|
|
||
| if let Annotated(Some(ref mut measurement_values), ref mut meta) = span.measurements { | ||
|
|
@@ -504,7 +504,7 @@ fn normalize( | |
| .data | ||
| .value_mut() | ||
| .as_mut() | ||
| .map(|data| &mut data.segment_name) | ||
| { | ||
| normalize_transaction_name(transaction, &project_config.tx_name_rules); | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed to future key.
transactionbecomes a legacy alias.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we update the docs too?