relay_event_normalization/normalize/
utils.rs

1//! **Deprecated.** Utilities for extracting common event fields.
2//!
3//! This utility module is being phased out. Functionality in this module should be moved to the
4//! specific normalization file requiring this data access.
5
6use std::f64::consts::SQRT_2;
7
8use relay_event_schema::protocol::{Event, ResponseContext, Span, TraceContext, User};
9use relay_protocol::Value;
10
11/// Used to decide when to extract mobile-specific tags.
12pub const MOBILE_SDKS: [&str; 4] = [
13    "sentry.cocoa",
14    "sentry.dart.flutter",
15    "sentry.java.android",
16    "sentry.javascript.react-native",
17];
18
19/// Allowed value for main thread name.
20pub const MAIN_THREAD_NAME: &str = "main";
21
22/// Maximum length of a mobile span or measurement in milliseconds.
23///
24/// Spans like `ui.load` with an `exclusive_time` that exceeds this number will be removed,
25/// as well as mobile measurements (on transactions) such as `app.start.cold`, etc.
26pub const MAX_DURATION_MOBILE_MS: f64 = 180_000.0;
27
28/// Extract the HTTP status code from the span data.
29pub fn http_status_code_from_span(span: &Span) -> Option<String> {
30    // For SDKs which put the HTTP status code into the span data.
31    if let Some(status_code) = span
32        .data
33        .value()
34        .and_then(|data| data.http_response_status_code.value())
35        .map(|v| match v {
36            Value::String(s) => Some(s.as_str().to_owned()),
37            Value::I64(i) => Some(i.to_string()),
38            Value::U64(u) => Some(u.to_string()),
39            _ => None,
40        })
41    {
42        return status_code;
43    }
44
45    // For SDKs which put the HTTP status code into the span tags.
46    if let Some(status_code) = span
47        .tags
48        .value()
49        .and_then(|tags| tags.get("http.status_code"))
50        .and_then(|v| v.as_str())
51        .map(|v| v.to_owned())
52    {
53        return Some(status_code);
54    }
55
56    None
57}
58
59/// Extracts the HTTP status code.
60pub fn extract_http_status_code(event: &Event) -> Option<String> {
61    // For SDKs which put the HTTP status code in the event tags.
62    if let Some(status_code) = event.tag_value("http.status_code") {
63        return Some(status_code.to_owned());
64    }
65
66    if let Some(spans) = event.spans.value() {
67        for span in spans {
68            if let Some(span_value) = span.value() {
69                if let Some(status_code) = http_status_code_from_span(span_value) {
70                    return Some(status_code);
71                }
72            }
73        }
74    }
75
76    // For SDKs which put the HTTP status code into the breadcrumbs data.
77    if let Some(breadcrumbs) = event.breadcrumbs.value() {
78        if let Some(values) = breadcrumbs.values.value() {
79            for breadcrumb in values {
80                // We need only the `http` type.
81                if let Some(crumb) = breadcrumb
82                    .value()
83                    .filter(|bc| bc.ty.as_str() == Some("http"))
84                {
85                    // Try to get the status code om the map.
86                    if let Some(status_code) = crumb.data.value().and_then(|v| v.get("status_code"))
87                    {
88                        return status_code.value().and_then(|v| v.as_str()).map(Into::into);
89                    }
90                }
91            }
92        }
93    }
94
95    // For SDKs which put the HTTP status code in the `Response` context.
96    if let Some(response_context) = event.context::<ResponseContext>() {
97        let status_code = response_context
98            .status_code
99            .value()
100            .map(|code| code.to_string());
101        return status_code;
102    }
103
104    None
105}
106
107/// Compute the transaction event's "user" tag as close as possible to how users are determined in
108/// the transactions dataset in Snuba. This should produce the exact same user counts as the `user`
109/// column in Discover for Transactions, barring:
110///
111/// * imprecision caused by HLL sketching in Snuba, which we don't have in events
112/// * hash collisions in `BucketValue::set_from_display`, which we don't have in events
113/// * MD5-collisions caused by `EventUser.hash_from_tag`, which we don't have in metrics
114///
115///   MD5 is used to efficiently look up the current event user for an event, and if there is a
116///   collision it seems that this code will fetch an event user with potentially different values
117///   for everything that is in `defaults`:
118///   <https://github.com/getsentry/sentry/blob/f621cd76da3a39836f34802ba9b35133bdfbe38b/src/sentry/event_manager.py#L1058-L1060>
119///
120/// The performance product runs a discover query such as `count_unique(user)`, which maps to two
121/// things:
122///
123/// * `user` metric for the metrics dataset
124/// * the "promoted tag" column `user` in the transactions clickhouse table
125///
126/// A promoted tag is a tag that snuba pulls out into its own column. In this case it pulls out the
127/// `sentry:user` tag from the event payload:
128/// <https://github.com/getsentry/snuba/blob/430763e67e30957c89126e62127e34051eb52fd6/snuba/datasets/transactions_processor.py#L151>
129///
130/// Sentry's processing pipeline defers to `sentry.models.EventUser` to produce the `sentry:user` tag
131/// here: <https://github.com/getsentry/sentry/blob/f621cd76da3a39836f34802ba9b35133bdfbe38b/src/sentry/event_manager.py#L790-L794>
132///
133/// `sentry.models.eventuser.KEYWORD_MAP` determines which attributes are looked up in which order, here:
134/// <https://github.com/getsentry/sentry/blob/f621cd76da3a39836f34802ba9b35133bdfbe38b/src/sentry/models/eventuser.py#L18>
135/// If its order is changed, this function needs to be changed.
136pub fn get_event_user_tag(user: &User) -> Option<String> {
137    if let Some(id) = user.id.as_str() {
138        return Some(format!("id:{id}"));
139    }
140
141    if let Some(username) = user.username.as_str() {
142        return Some(format!("username:{username}"));
143    }
144
145    if let Some(email) = user.email.as_str() {
146        return Some(format!("email:{email}"));
147    }
148
149    if let Some(ip_address) = user.ip_address.as_str() {
150        return Some(format!("ip:{ip_address}"));
151    }
152
153    None
154}
155
156/// Returns a normalized `op` from the given trace context.
157pub fn extract_transaction_op(trace_context: &TraceContext) -> Option<String> {
158    let op = trace_context.op.value()?;
159    if op == "default" {
160        // This was likely set by normalization, so let's treat it as None
161        // See https://github.com/getsentry/relay/blob/bb2ac4ee82c25faa07a6d078f93d22d799cfc5d1/relay-general/src/store/transactions.rs#L96
162
163        // Note that this is the opposite behavior of what we do for transaction.status, where
164        // we coalesce None to "unknown".
165        return None;
166    }
167    Some(op.to_string())
168}
169
170/// The Gauss error function.
171///
172/// See <https://en.wikipedia.org/wiki/Error_function>.
173fn erf(x: f64) -> f64 {
174    // constants
175    let a1 = 0.254829592;
176    let a2 = -0.284496736;
177    let a3 = 1.421413741;
178    let a4 = -1.453152027;
179    let a5 = 1.061405429;
180    let p = 0.3275911;
181    // Save the sign of x
182    let sign = if x < 0.0 { -1.0 } else { 1.0 };
183    let x = x.abs();
184    // A&S formula 7.1.26
185    let t = 1.0 / (1.0 + p * x);
186    let y = 1.0 - ((((a5 * t + a4) * t + a3) * t + a2) * t + a1) * t * (-x * x).exp();
187    sign * y
188}
189
190/// Sigma function for CDF score calculation.
191fn calculate_cdf_sigma(p10: f64, p50: f64) -> f64 {
192    (p10.ln() - p50.ln()).abs() / (SQRT_2 * 0.9061938024368232)
193}
194
195/// Calculates a log-normal CDF score based on a log-normal with a specific p10 and p50
196pub fn calculate_cdf_score(value: f64, p10: f64, p50: f64) -> f64 {
197    0.5 * (1.0 - erf((f64::ln(value) - f64::ln(p50)) / (SQRT_2 * calculate_cdf_sigma(p50, p10))))
198}
199
200#[cfg(test)]
201mod tests {
202    use crate::utils::{get_event_user_tag, http_status_code_from_span};
203    use relay_event_schema::protocol::{Span, User};
204    use relay_protocol::Annotated;
205
206    #[test]
207    fn test_get_event_user_tag() {
208        // Note: If this order changes,
209        // https://github.com/getsentry/sentry/blob/f621cd76da3a39836f34802ba9b35133bdfbe38b/src/sentry/models/eventuser.py#L18
210        // has to be changed. Though it is probably not a good idea!
211        let user = User {
212            id: Annotated::new("ident".to_owned().into()),
213            username: Annotated::new("username".to_owned().into()),
214            email: Annotated::new("email".to_owned()),
215            ip_address: Annotated::new("127.0.0.1".parse().unwrap()),
216            ..User::default()
217        };
218
219        assert_eq!(get_event_user_tag(&user).unwrap(), "id:ident");
220
221        let user = User {
222            username: Annotated::new("username".to_owned().into()),
223            email: Annotated::new("email".to_owned()),
224            ip_address: Annotated::new("127.0.0.1".parse().unwrap()),
225            ..User::default()
226        };
227
228        assert_eq!(get_event_user_tag(&user).unwrap(), "username:username");
229
230        let user = User {
231            email: Annotated::new("email".to_owned()),
232            ip_address: Annotated::new("127.0.0.1".parse().unwrap()),
233            ..User::default()
234        };
235
236        assert_eq!(get_event_user_tag(&user).unwrap(), "email:email");
237
238        let user = User {
239            ip_address: Annotated::new("127.0.0.1".parse().unwrap()),
240            ..User::default()
241        };
242
243        assert_eq!(get_event_user_tag(&user).unwrap(), "ip:127.0.0.1");
244
245        let user = User::default();
246
247        assert!(get_event_user_tag(&user).is_none());
248    }
249
250    #[test]
251    fn test_extracts_http_status_code_when_int() {
252        let span = Annotated::<Span>::from_json(
253            r#"{
254                "data": {
255                    "http.response.status_code": 400
256                }
257            }"#,
258        )
259        .unwrap()
260        .into_value()
261        .unwrap();
262
263        let result = http_status_code_from_span(&span);
264
265        assert_eq!(result, Some("400".to_string()));
266    }
267}
relay_event_normalization/normalize/utils.rs

relay_event_normalization/normalize/
utils.rs
