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

relay_event_schema/protocol/span/
convert.rs
