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.

Sign up for GitHub

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

ref(metrics): Use MRI for metrics extraction [INGEST-939] #1215

Merged
merged 7 commits into from
Apr 7, 2022
Merged

ref(metrics): Use MRI for metrics extraction [INGEST-939] #1215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3486ca8
ref(metrics): Use MRI for metrics extraction
jan-auer Mar 29, 2022
321b061
test(metrics): Fix remaining comparisons
jan-auer Mar 30, 2022
57fa5c4
meta: Changelog
jan-auer Mar 30, 2022
0f2fad3
ref(metrics): Update signature for MRI
jan-auer Mar 30, 2022
163260e
fix(metrics): Restore imports
jan-auer Mar 30, 2022
bc1468f
fix(metrics): Re-introduce span_ops metric prefix
jan-auer Apr 7, 2022
3f4bdf1
Merge branch 'master' into ref/metrics-mri
jan-auer Apr 7, 2022
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

- Remove unused item types. ([#1211](https://github.com/getsentry/relay/pull/1211))
- Pin click dependency in requirements-dev.txt. ([#1214](https://github.com/getsentry/relay/pull/1214))
- Use fully qualified metric resource identifiers (MRI) for metrics ingestion. For example, the sessions duration is now called `d:sessions/duration@s`. ([#1215](https://github.com/getsentry/relay/pull/1215))

## 22.3.0

Expand Down
21 changes: 21 additions & 0 deletions relay-metrics/src/protocol.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,27 @@ pub struct Metric {
}

impl Metric {
/// Creates a new metric using the MRI naming format.
///
/// MRI is the metric resource identifier in the format `<type>:<ns>/<name>@<unit>`. This name
/// ensures that just the name determines correct bucketing of metrics with name collisions.
pub fn new_mri(
namespace: impl fmt::Display,
name: impl fmt::Display,
unit: MetricUnit,
value: MetricValue,
timestamp: UnixTimestamp,
tags: BTreeMap<String, String>,
) -> Self {
Self {
name: format!("{}:{}/{}@{}", value.ty(), namespace, name, unit),
unit,
value,
timestamp,
tags,
}
}

fn parse_str(string: &str, timestamp: UnixTimestamp) -> Option<Self> {
let mut components = string.split('|');

Expand Down
171 changes: 88 additions & 83 deletions relay-server/src/metrics_extraction/sessions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,7 @@ fn nil_to_none(distinct_id: Option<&String>) -> Option<&String> {
Some(distinct_id)
}

/// Generate a sessions-related metric name
/// Would be nice to have this as a `const fn`, but [`Metric`] requires a [`String`] anyway.
fn metric_name(name: &str) -> String {
format!("sentry.sessions.{}", name)
}
const METRIC_NAMESPACE: &str = "sessions";

pub fn extract_session_metrics<T: SessionLike>(
attributes: &SessionAttributes,
Expand All @@ -46,110 +42,119 @@ pub fn extract_session_metrics<T: SessionLike>(
// Always capture with "init" tag for the first session update of a session. This is used
// for adoption and as baseline for crash rates.
if session.total_count() > 0 {
target.push(Metric {
name: metric_name("session"),
unit: MetricUnit::None,
value: MetricValue::Counter(session.total_count() as f64),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"session",
MetricUnit::None,
MetricValue::Counter(session.total_count() as f64),
timestamp,
tags: with_tag(&tags, "session.status", "init"),
});
with_tag(&tags, "session.status", "init"),
));

if let Some(distinct_id) = nil_to_none(session.distinct_id()) {
target.push(Metric {
name: metric_name("user"),
unit: MetricUnit::None,
value: MetricValue::set_from_str(distinct_id),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"user",
MetricUnit::None,
MetricValue::set_from_str(distinct_id),
timestamp,
tags: with_tag(&tags, "session.status", "init"),
});
with_tag(&tags, "session.status", "init"),
));
}
}

// Mark the session as errored, which includes fatal sessions.
if let Some(errors) = session.errors() {
target.push(match errors {
SessionErrored::Individual(session_id) => Metric {
name: metric_name("session.error"),
unit: MetricUnit::None,
value: MetricValue::set_from_display(session_id),
SessionErrored::Individual(session_id) => Metric::new_mri(
METRIC_NAMESPACE,
"error",
MetricUnit::None,
MetricValue::set_from_display(session_id),
timestamp,
tags: tags.clone(),
},
SessionErrored::Aggregated(count) => Metric {
name: metric_name("session"),
unit: MetricUnit::None,
value: MetricValue::Counter(count as f64),
tags.clone(),
),
SessionErrored::Aggregated(count) => Metric::new_mri(
METRIC_NAMESPACE,
"session",
MetricUnit::None,
MetricValue::Counter(count as f64),
timestamp,
tags: with_tag(&tags, "session.status", "errored_preaggr"),
},
with_tag(&tags, "session.status", "errored_preaggr"),
),
});

if let Some(distinct_id) = nil_to_none(session.distinct_id()) {
target.push(Metric {
name: metric_name("user"),
unit: MetricUnit::None,
value: MetricValue::set_from_str(distinct_id),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"user",
MetricUnit::None,
MetricValue::set_from_str(distinct_id),
timestamp,
tags: with_tag(&tags, "session.status", "errored"),
});
with_tag(&tags, "session.status", "errored"),
));
}
}

// Record fatal sessions for crash rate computation. This is a strict subset of errored
// sessions above.
if session.abnormal_count() > 0 {
target.push(Metric {
name: metric_name("session"),
unit: MetricUnit::None,
value: MetricValue::Counter(session.abnormal_count() as f64),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"session",
MetricUnit::None,
MetricValue::Counter(session.abnormal_count() as f64),
timestamp,
tags: with_tag(&tags, "session.status", SessionStatus::Abnormal),
});
with_tag(&tags, "session.status", SessionStatus::Abnormal),
));

if let Some(distinct_id) = nil_to_none(session.distinct_id()) {
target.push(Metric {
name: metric_name("user"),
unit: MetricUnit::None,
value: MetricValue::set_from_str(distinct_id),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"user",
MetricUnit::None,
MetricValue::set_from_str(distinct_id),
timestamp,
tags: with_tag(&tags, "session.status", SessionStatus::Abnormal),
});
with_tag(&tags, "session.status", SessionStatus::Abnormal),
));
}
}

if session.crashed_count() > 0 {
target.push(Metric {
name: metric_name("session"),
unit: MetricUnit::None,
value: MetricValue::Counter(session.crashed_count() as f64),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"session",
MetricUnit::None,
MetricValue::Counter(session.crashed_count() as f64),
timestamp,
tags: with_tag(&tags, "session.status", SessionStatus::Crashed),
});
with_tag(&tags, "session.status", SessionStatus::Crashed),
));

if let Some(distinct_id) = nil_to_none(session.distinct_id()) {
target.push(Metric {
name: metric_name("user"),
unit: MetricUnit::None,
value: MetricValue::set_from_str(distinct_id),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"user",
MetricUnit::None,
MetricValue::set_from_str(distinct_id),
timestamp,
tags: with_tag(&tags, "session.status", SessionStatus::Crashed),
});
with_tag(&tags, "session.status", SessionStatus::Crashed),
));
}
}

// Count durations for all exited/crashed sessions. Note that right now, in the product we
// really only use durations from session.status=exited, but decided it may be worth ingesting
// this data in case we need it. If we need to cut cost, this is one place to start though.
// if session.status.is_terminal() {
if let Some((duration, status)) = session.final_duration() {
target.push(Metric {
name: metric_name("session.duration"),
unit: MetricUnit::Duration(DurationPrecision::Second),
value: MetricValue::Distribution(duration),
target.push(Metric::new_mri(
METRIC_NAMESPACE,
"duration",
MetricUnit::Duration(DurationPrecision::Second),
MetricValue::Distribution(duration),
timestamp,
tags: with_tag(&tags, "session.status", status),
});
with_tag(&tags, "session.status", status),
));
}
// }
}

#[cfg(test)]
Expand Down Expand Up @@ -210,14 +215,14 @@ mod tests {

let session_metric = &metrics[0];
assert_eq!(session_metric.timestamp, started());
assert_eq!(session_metric.name, "sentry.sessions.session");
assert_eq!(session_metric.name, "c:sessions/session@");
assert!(matches!(session_metric.value, MetricValue::Counter(_)));
assert_eq!(session_metric.tags["session.status"], "init");
assert_eq!(session_metric.tags["release"], "1.0.0");

let user_metric = &metrics[1];
assert_eq!(session_metric.timestamp, started());
assert_eq!(user_metric.name, "sentry.sessions.user");
assert_eq!(user_metric.name, "s:sessions/user@");
assert!(matches!(user_metric.value, MetricValue::Set(_)));
assert_eq!(session_metric.tags["session.status"], "init");
assert_eq!(user_metric.tags["release"], "1.0.0");
Expand Down Expand Up @@ -281,13 +286,13 @@ mod tests {

let session_metric = &metrics[expected_metrics - 2];
assert_eq!(session_metric.timestamp, started());
assert_eq!(session_metric.name, "sentry.sessions.session.error");
assert_eq!(session_metric.name, "s:sessions/error@");
assert!(matches!(session_metric.value, MetricValue::Set(_)));
assert_eq!(session_metric.tags.len(), 1); // Only the release tag

let user_metric = &metrics[expected_metrics - 1];
assert_eq!(session_metric.timestamp, started());
assert_eq!(user_metric.name, "sentry.sessions.user");
assert_eq!(user_metric.name, "s:sessions/user@");
assert!(matches!(user_metric.value, MetricValue::Set(_)));
assert_eq!(user_metric.tags["session.status"], "errored");
assert_eq!(user_metric.tags["release"], "1.0.0");
Expand Down Expand Up @@ -317,19 +322,19 @@ mod tests {

assert_eq!(metrics.len(), 4);

assert_eq!(metrics[0].name, "sentry.sessions.session.error");
assert_eq!(metrics[1].name, "sentry.sessions.user");
assert_eq!(metrics[0].name, "s:sessions/error@");
assert_eq!(metrics[1].name, "s:sessions/user@");
assert_eq!(metrics[1].tags["session.status"], "errored");

let session_metric = &metrics[2];
assert_eq!(session_metric.timestamp, started());
assert_eq!(session_metric.name, "sentry.sessions.session");
assert_eq!(session_metric.name, "c:sessions/session@");
assert!(matches!(session_metric.value, MetricValue::Counter(_)));
assert_eq!(session_metric.tags["session.status"], status.to_string());

let user_metric = &metrics[3];
assert_eq!(session_metric.timestamp, started());
assert_eq!(user_metric.name, "sentry.sessions.user");
assert_eq!(user_metric.name, "s:sessions/user@");
assert!(matches!(user_metric.value, MetricValue::Set(_)));
assert_eq!(user_metric.tags["session.status"], status.to_string());
}
Expand Down Expand Up @@ -359,7 +364,7 @@ mod tests {
assert_eq!(metrics.len(), 1);

let duration_metric = &metrics[0];
assert_eq!(duration_metric.name, "sentry.sessions.session.duration");
assert_eq!(duration_metric.name, "d:sessions/duration@s");
assert!(matches!(
duration_metric.value,
MetricValue::Distribution(_)
Expand Down Expand Up @@ -402,7 +407,7 @@ mod tests {
insta::assert_debug_snapshot!(metrics, @r###"
[
Metric {
name: "sentry.sessions.session",
name: "c:sessions/session@",
unit: None,
value: Counter(
135.0,
Expand All @@ -415,7 +420,7 @@ mod tests {
},
},
Metric {
name: "sentry.sessions.session",
name: "c:sessions/session@",
unit: None,
value: Counter(
5.0,
Expand All @@ -428,7 +433,7 @@ mod tests {
},
},
Metric {
name: "sentry.sessions.session",
name: "c:sessions/session@",
unit: None,
value: Counter(
7.0,
Expand All @@ -441,7 +446,7 @@ mod tests {
},
},
Metric {
name: "sentry.sessions.session",
name: "c:sessions/session@",
unit: None,
value: Counter(
15.0,
Expand All @@ -454,7 +459,7 @@ mod tests {
},
},
Metric {
name: "sentry.sessions.user",
name: "s:sessions/user@",
unit: None,
value: Set(
3097475539,
Expand All @@ -467,7 +472,7 @@ mod tests {
},
},
Metric {
name: "sentry.sessions.session",
name: "c:sessions/session@",
unit: None,
value: Counter(
3.0,
Expand All @@ -480,7 +485,7 @@ mod tests {
},
},
Metric {
name: "sentry.sessions.user",
name: "s:sessions/user@",
unit: None,
value: Set(
3097475539,
Expand Down
Loading