relay_event_schema/protocol/span/
convert.rs

1//! This module defines bidirectional field mappings between spans and transactions.
2
3use crate::protocol::{BrowserContext, Event, ProfileContext, Span, SpanData, TraceContext};
4
5impl From<&Event> for Span {
6    fn from(event: &Event) -> Self {
7        let Event {
8            transaction,
9
10            platform,
11            timestamp,
12            start_timestamp,
13            received,
14            release,
15            environment,
16            tags,
17
18            measurements,
19            _metrics,
20            performance_issues_spans,
21            ..
22        } = event;
23
24        let trace = event.context::<TraceContext>();
25
26        // Fill data from trace context:
27        let mut data = trace
28            .map(|c| c.data.clone().map_value(SpanData::from))
29            .unwrap_or_default();
30
31        // Overwrite specific fields:
32        let span_data = data.get_or_insert_with(Default::default);
33        span_data.segment_name = transaction.clone();
34        span_data.release = release.clone();
35        span_data.environment = environment.clone();
36        if let Some(browser) = event.context::<BrowserContext>() {
37            span_data.browser_name = browser.name.clone();
38        }
39        if let Some(client_sdk) = event.client_sdk.value() {
40            span_data.sdk_name = client_sdk.name.clone();
41            span_data.sdk_version = client_sdk.version.clone();
42        }
43        if let Some(request) = event.request.value()
44            && let Some(query) = request.query_string.value()
45            && let Some(qs) = query.to_query_string()
46        {
47            span_data.http_query = format!("?{qs}").into();
48            span_data.url_query = qs.into();
49        }
50
51        Self {
52            timestamp: timestamp.clone(),
53            start_timestamp: start_timestamp.clone(),
54            exclusive_time: trace.map(|c| c.exclusive_time.clone()).unwrap_or_default(),
55            op: trace.map(|c| c.op.clone()).unwrap_or_default(),
56            span_id: trace.map(|c| c.span_id.clone()).unwrap_or_default(),
57            parent_span_id: trace.map(|c| c.parent_span_id.clone()).unwrap_or_default(),
58            trace_id: trace.map(|c| c.trace_id.clone()).unwrap_or_default(),
59            segment_id: trace.map(|c| c.span_id.clone()).unwrap_or_default(),
60            is_segment: true.into(),
61            // NB: Technically, this span may not be an actual remote span if this is a child
62            // transaction created within the same service as its parent. We still set `is_remote`
63            // as the best proxy to ensure this span will be detected as a segment by the spans
64            // pipeline.
65            is_remote: true.into(),
66            status: trace.map(|c| c.status.clone()).unwrap_or_default(),
67            description: transaction.clone(),
68            tags: tags.clone().map_value(|t| t.into()),
69            origin: trace.map(|c| c.origin.clone()).unwrap_or_default(),
70            profile_id: event
71                .context::<ProfileContext>()
72                .map(|c| c.profile_id.clone())
73                .unwrap_or_default(),
74            data,
75            links: trace.map(|c| c.links.clone()).unwrap_or_default(),
76            sentry_tags: Default::default(),
77            received: received.clone(),
78            measurements: measurements.clone(),
79            platform: platform.clone(),
80            was_transaction: true.into(),
81            kind: Default::default(),
82            performance_issues_spans: performance_issues_spans.clone(),
83            other: Default::default(),
84        }
85    }
86}
87
88#[cfg(test)]
89mod tests {
90    use relay_protocol::Annotated;
91
92    use super::*;
93
94    #[test]
95    fn convert() {
96        let event = Annotated::<Event>::from_json(
97            r#"{
98                "type": "transaction",
99                "platform": "php",
100                "sdk": {"name": "sentry.php", "version": "1.2.3"},
101                "release": "myapp@1.0.0",
102                "environment": "prod",
103                "transaction": "my 1st transaction",
104                "contexts": {
105                    "browser": {"name": "Chrome"},
106                    "profile": {"profile_id": "a0aaaaaaaaaaaaaaaaaaaaaaaaaaaaab"},
107                    "trace": {
108                        "trace_id": "4C79F60C11214EB38604F4AE0781BFB2",
109                        "span_id": "FA90FDEAD5F74052",
110                        "type": "trace",
111                        "origin": "manual",
112                        "op": "myop",
113                        "status": "ok",
114                        "exclusive_time": 123.4,
115                        "parent_span_id": "FA90FDEAD5F74051",
116                        "data": {
117                            "custom_attribute": 42
118                        },
119                        "links": [
120                            {
121                                "trace_id": "4c79f60c11214eb38604f4ae0781bfb2",
122                                "span_id": "fa90fdead5f74052",
123                                "sampled": true,
124                                "attributes": {
125                                    "sentry.link.type": "previous_trace"
126                                }
127                            }
128                        ]
129                    }
130                },
131                "request": {
132                    "url": "http://example.com/api/0/organizations/",
133                    "method": "GET",
134                    "query_string": "project=1&sort=date"
135                },
136                "measurements": {
137                    "memory": {
138                        "value": 9001.0,
139                        "unit": "byte"
140                    }
141                }
142            }"#,
143        )
144        .unwrap()
145        .into_value()
146        .unwrap();
147
148        let span_from_event = Span::from(&event);
149        insta::assert_debug_snapshot!(span_from_event, @r###"
150        Span {
151            timestamp: ~,
152            start_timestamp: ~,
153            exclusive_time: 123.4,
154            op: "myop",
155            span_id: SpanId("fa90fdead5f74052"),
156            parent_span_id: SpanId("fa90fdead5f74051"),
157            trace_id: TraceId("4c79f60c11214eb38604f4ae0781bfb2"),
158            segment_id: SpanId("fa90fdead5f74052"),
159            is_segment: true,
160            is_remote: true,
161            status: Ok,
162            description: "my 1st transaction",
163            tags: ~,
164            origin: "manual",
165            profile_id: EventId(
166                a0aaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaab,
167            ),
168            data: SpanData {
169                app_start_type: ~,
170                gen_ai_request_max_tokens: ~,
171                gen_ai_pipeline_name: ~,
172                gen_ai_usage_total_tokens: ~,
173                gen_ai_usage_input_tokens: ~,
174                gen_ai_usage_input_tokens_cached: ~,
175                gen_ai_usage_input_tokens_cache_write: ~,
176                gen_ai_usage_input_tokens_cache_miss: ~,
177                gen_ai_usage_output_tokens: ~,
178                gen_ai_usage_output_tokens_reasoning: ~,
179                gen_ai_usage_output_tokens_prediction_accepted: ~,
180                gen_ai_usage_output_tokens_prediction_rejected: ~,
181                gen_ai_response_model: ~,
182                gen_ai_request_model: ~,
183                gen_ai_context_window_size: ~,
184                gen_ai_context_utilization: ~,
185                gen_ai_cost_total_tokens: ~,
186                gen_ai_cost_input_tokens: ~,
187                gen_ai_cost_output_tokens: ~,
188                gen_ai_input_messages: ~,
189                gen_ai_tool_input: ~,
190                gen_ai_tool_output: ~,
191                gen_ai_response_tool_calls: ~,
192                gen_ai_output_messages: ~,
193                gen_ai_response_object: ~,
194                gen_ai_response_streaming: ~,
195                gen_ai_response_tokens_per_second: ~,
196                gen_ai_response_time_to_first_token: ~,
197                gen_ai_request_available_tools: ~,
198                gen_ai_request_frequency_penalty: ~,
199                gen_ai_request_presence_penalty: ~,
200                gen_ai_request_seed: ~,
201                gen_ai_request_temperature: ~,
202                gen_ai_request_top_k: ~,
203                gen_ai_request_top_p: ~,
204                gen_ai_response_finish_reason: ~,
205                gen_ai_response_id: ~,
206                gen_ai_system: ~,
207                gen_ai_system_instructions: ~,
208                gen_ai_tool_name: ~,
209                gen_ai_operation_name: ~,
210                gen_ai_operation_type: ~,
211                gen_ai_agent_name: ~,
212                gen_ai_function_id: ~,
213                mcp_prompt_result: ~,
214                mcp_tool_result_content: ~,
215                browser_name: "Chrome",
216                code_filepath: ~,
217                code_lineno: ~,
218                code_function: ~,
219                code_namespace: ~,
220                db_operation: ~,
221                db_system: ~,
222                db_collection_name: ~,
223                environment: "prod",
224                release: LenientString(
225                    "myapp@1.0.0",
226                ),
227                http_decoded_response_content_length: ~,
228                http_request_method: ~,
229                http_response_content_length: ~,
230                http_response_transfer_size: ~,
231                resource_render_blocking_status: ~,
232                server_address: ~,
233                cache_hit: ~,
234                cache_key: ~,
235                cache_item_size: ~,
236                http_response_status_code: ~,
237                thread_name: ~,
238                thread_id: ~,
239                segment_name: "my 1st transaction",
240                ui_component_name: ~,
241                url_scheme: ~,
242                user: ~,
243                user_email: ~,
244                user_full_name: ~,
245                user_geo_country_code: ~,
246                user_geo_city: ~,
247                user_geo_subdivision: ~,
248                user_geo_region: ~,
249                user_hash: ~,
250                user_id: ~,
251                user_name: ~,
252                user_roles: ~,
253                exclusive_time: ~,
254                profile_id: ~,
255                replay_id: ~,
256                sdk_name: "sentry.php",
257                sdk_version: "1.2.3",
258                frames_slow: ~,
259                frames_frozen: ~,
260                frames_total: ~,
261                frames_delay: ~,
262                messaging_destination_name: ~,
263                messaging_message_retry_count: ~,
264                messaging_message_receive_latency: ~,
265                messaging_message_body_size: ~,
266                messaging_message_id: ~,
267                messaging_operation_name: ~,
268                messaging_operation_type: ~,
269                user_agent_original: ~,
270                url_full: ~,
271                url_query: "project=1&sort=date",
272                http_query: "?project=1&sort=date",
273                client_address: ~,
274                route: ~,
275                previous_route: ~,
276                lcp_element: ~,
277                lcp_size: ~,
278                lcp_id: ~,
279                lcp_url: ~,
280                span_name: ~,
281                other: {
282                    "custom_attribute": I64(
283                        42,
284                    ),
285                },
286            },
287            links: [
288                SpanLink {
289                    trace_id: TraceId("4c79f60c11214eb38604f4ae0781bfb2"),
290                    span_id: SpanId("fa90fdead5f74052"),
291                    sampled: true,
292                    attributes: {
293                        "sentry.link.type": String(
294                            "previous_trace",
295                        ),
296                    },
297                    other: {},
298                },
299            ],
300            sentry_tags: ~,
301            received: ~,
302            measurements: Measurements(
303                {
304                    "memory": Measurement {
305                        value: 9001.0,
306                        unit: Information(
307                            Byte,
308                        ),
309                    },
310                },
311            ),
312            platform: "php",
313            was_transaction: true,
314            kind: ~,
315            performance_issues_spans: ~,
316            other: {},
317        }
318        "###);
319    }
320}
relay_event_schema/protocol/span/convert.rs

relay_event_schema/protocol/span/
convert.rs
