Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(metrics): Add units in built-in measurements [INGEST-1056] #1229

Merged
merged 5 commits into from
Apr 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
**Features**:

- Map Windows version from raw_description to version name (XP, Vista, 11, ...). ([#1219](https://github.com/getsentry/relay/pull/1219))
- Add units in built-in measurements. ([#1229](https://github.com/getsentry/relay/pull/1229))

**Bug Fixes**:

Expand Down
111 changes: 103 additions & 8 deletions relay-server/src/metrics_extraction/transactions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,36 @@ fn extract_user_satisfaction(
None
}

/// Returns the unit of the provided metric. Defaults to None.
#[cfg(feature = "processing")]
fn get_metric_measurement_unit(metric: &str) -> MetricUnit {
match metric {
// Web
"fcp" => MetricUnit::Duration(DurationUnit::MilliSecond),
"lcp" => MetricUnit::Duration(DurationUnit::MilliSecond),
"fid" => MetricUnit::Duration(DurationUnit::MilliSecond),
"fp" => MetricUnit::Duration(DurationUnit::MilliSecond),
"ttfb" => MetricUnit::Duration(DurationUnit::MilliSecond),
"ttfb.requesttime" => MetricUnit::Duration(DurationUnit::MilliSecond),
"cls" => MetricUnit::None,

// Mobile
"app_start_cold" => MetricUnit::Duration(DurationUnit::MilliSecond),
"app_start_warm" => MetricUnit::Duration(DurationUnit::MilliSecond),
"frames_total" => MetricUnit::None,
"frames_slow" => MetricUnit::None,
"frames_frozen" => MetricUnit::None,

// React-Native
"stall_count" => MetricUnit::None,
"stall_total_time" => MetricUnit::Duration(DurationUnit::MilliSecond),
"stall_longest_time" => MetricUnit::Duration(DurationUnit::MilliSecond),

// Default
_ => MetricUnit::None,
}
}

#[cfg(feature = "processing")]
pub fn extract_transaction_metrics(
config: &TransactionMetricsConfig,
Expand Down Expand Up @@ -251,7 +281,7 @@ fn extract_transaction_metrics_inner(
push_metric(Metric::new_mri(
METRIC_NAMESPACE,
format_args!("measurements.{}", measurement_name),
MetricUnit::None,
get_metric_measurement_unit(measurement_name),
MetricValue::Distribution(measurement),
unix_timestamp,
tags,
Expand Down Expand Up @@ -423,7 +453,7 @@ mod tests {
{
"extractMetrics": [
"d:transactions/measurements.foo@none",
"d:transactions/measurements.lcp@none",
"d:transactions/measurements.lcp@millisecond",
"d:transactions/breakdowns.span_ops.ops.react.mount@none",
"d:transactions/duration@millisecond",
"s:transactions/user@none"
Expand All @@ -446,7 +476,10 @@ mod tests {
assert_eq!(metrics.len(), 5, "{:?}", metrics);

assert_eq!(metrics[0].name, "d:transactions/measurements.foo@none");
assert_eq!(metrics[1].name, "d:transactions/measurements.lcp@none");
assert_eq!(
metrics[1].name,
"d:transactions/measurements.lcp@millisecond"
);
assert_eq!(
metrics[2].name,
"d:transactions/breakdowns.span_ops.ops.react.mount@none"
Expand Down Expand Up @@ -480,6 +513,68 @@ mod tests {
}
}

#[test]
fn test_metric_measurement_units() {
let json = r#"
{
"type": "transaction",
"timestamp": "2021-04-26T08:00:00+0100",
"start_timestamp": "2021-04-26T07:59:01+0100",
"measurements": {
"fcp": {"value": 1.1},
"stall_count": {"value": 3.3},
"foo": {"value": 8.8}
}
}
"#;

let config: TransactionMetricsConfig = serde_json::from_str(
r#"
{
"extractMetrics": [
"d:transactions/measurements.fcp@millisecond",
"d:transactions/measurements.stall_count@none",
"d:transactions/measurements.foo@none"
]
}
"#,
)
.unwrap();

let event = Annotated::from_json(json).unwrap();

let mut metrics = vec![];
extract_transaction_metrics(&config, None, &[], event.value().unwrap(), &mut metrics);

assert_eq!(metrics.len(), 3, "{:?}", metrics);

assert_eq!(
metrics[0].name, "d:transactions/measurements.fcp@millisecond",
"{:?}",
metrics[0]
);
assert_eq!(
metrics[0].unit,
MetricUnit::Duration(DurationUnit::MilliSecond),
"{:?}",
metrics[0]
);

assert_eq!(
metrics[1].name, "d:transactions/measurements.foo@none",
"{:?}",
metrics[1]
);
assert_eq!(metrics[1].unit, MetricUnit::None, "{:?}", metrics[1]);

assert_eq!(
metrics[2].name, "d:transactions/measurements.stall_count@none",
"{:?}",
metrics[2]
);
assert_eq!(metrics[2].unit, MetricUnit::None, "{:?}", metrics[2]);
}

#[test]
fn test_transaction_duration() {
let json = r#"
Expand Down Expand Up @@ -767,7 +862,7 @@ mod tests {
r#"
{
"extractMetrics": [
"d:transactions/measurements.lcp@none"
"d:transactions/measurements.lcp@millisecond"
]
}
"#,
Expand All @@ -779,19 +874,19 @@ mod tests {
[
{
"condition": {"op": "gte", "name": "transaction.measurements.lcp", "value": 41},
"targetMetrics": ["d:transactions/measurements.lcp@none"],
"targetMetrics": ["d:transactions/measurements.lcp@millisecond"],
"targetTag": "satisfaction",
"tagValue": "frustrated"
},
{
"condition": {"op": "gte", "name": "transaction.measurements.lcp", "value": 20},
"targetMetrics": ["d:transactions/measurements.lcp@none"],
"targetMetrics": ["d:transactions/measurements.lcp@millisecond"],
"targetTag": "satisfaction",
"tagValue": "tolerated"
},
{
"condition": {"op": "and", "inner": []},
"targetMetrics": ["d:transactions/measurements.lcp@none"],
"targetMetrics": ["d:transactions/measurements.lcp@millisecond"],
"targetTag": "satisfaction",
"tagValue": "satisfied"
}
Expand All @@ -813,7 +908,7 @@ mod tests {
&[Metric::new_mri(
METRIC_NAMESPACE,
"measurements.lcp",
MetricUnit::None,
MetricUnit::Duration(DurationUnit::MilliSecond),
MetricValue::Distribution(41.0),
UnixTimestamp::from_secs(1619420402),
{
Expand Down