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: Extract normalized dist as metric [INGEST-335] #1158

Merged
merged 5 commits into from
Dec 16, 2021
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 @@ -26,6 +26,7 @@
- Extract session metrics from aggregate sessions. ([#1140](https://github.com/getsentry/relay/pull/1140))
- Prefix names of extracted metrics by `sentry.sessions.` or `sentry.transactions.`. ([#1147](https://github.com/getsentry/relay/pull/1147))
- Extract transaction duration as metric. ([#1148](https://github.com/getsentry/relay/pull/1148))
- Extract normalized dist as metric. ([#1158](https://github.com/getsentry/relay/pull/1158))

## 21.11.0

Expand Down
1 change: 1 addition & 0 deletions relay-general/src/store/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ mod trimming;
pub use self::clock_drift::ClockDriftProcessor;
pub use self::geo::{GeoIpError, GeoIpLookup};
pub use normalize::breakdowns::BreakdownsConfig;
pub use normalize::normalize_dist;

/// The config for store.
#[derive(Serialize, Deserialize, Debug, Default)]
Expand Down
54 changes: 45 additions & 9 deletions relay-general/src/store/normalize.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,22 @@ fn is_valid_platform(platform: &str) -> bool {
VALID_PLATFORMS.contains(&platform)
}

pub fn normalize_dist(dist: &mut Option<String>) {
let mut erase = false;
if let Some(val) = dist {
if val.is_empty() {
erase = true;
}
let trimmed = val.trim();
if trimmed != val {
*val = trimmed.to_string()
}
}
if erase {
*dist = None;
}
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the erase flag here because I cannot set dist while checking its contents. I don't like it though - any suggestions welcome.


/// The processor that normalizes events for store.
pub struct NormalizeProcessor<'a> {
config: Arc<StoreConfig>,
Expand Down Expand Up @@ -120,15 +136,7 @@ impl<'a> NormalizeProcessor<'a> {

/// Ensures that the `release` and `dist` fields match up.
fn normalize_release_dist(&self, event: &mut Event) {
if event.dist.value().is_some() && event.release.value().is_empty() {
event.dist.set_value(None);
}

if let Some(dist) = event.dist.value_mut() {
if dist.trim() != dist {
*dist = dist.trim().to_string();
}
}
normalize_dist(event.dist.value_mut());
}

/// Validates the timestamp range and sets a default value.
Expand Down Expand Up @@ -1600,3 +1608,31 @@ fn test_past_timestamp() {
}
"###);
}

#[test]
fn test_normalize_dist_none() {
let mut dist = None;
normalize_dist(&mut dist);
assert_eq!(dist, None);
}

#[test]
fn test_normalize_dist_empty() {
let mut dist = Some("".to_owned());
normalize_dist(&mut dist);
assert_eq!(dist, None);
}

#[test]
fn test_normalize_dist_trim() {
let mut dist = Some(" foo ".to_owned());
normalize_dist(&mut dist);
assert_eq!(dist.unwrap(), "foo");
}

#[test]
fn test_normalize_dist_whitespace() {
let mut dist = Some(" ".to_owned());
normalize_dist(&mut dist);
assert_eq!(dist.unwrap(), ""); // Not sure if this is what we want
}
18 changes: 16 additions & 2 deletions relay-server/src/metrics_extraction/transactions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use std::collections::BTreeSet;
use {
relay_common::UnixTimestamp,
relay_general::protocol::{AsPair, Event, EventType},
relay_general::store::normalize_dist,
relay_metrics::{Metric, MetricUnit, MetricValue},
std::collections::BTreeMap,
std::fmt::Write,
Expand Down Expand Up @@ -34,7 +35,7 @@ fn metric_name(parts: &[&str]) -> String {
}

#[cfg(feature = "processing")]
fn transaction_status(transaction: &Event) -> Option<String> {
fn extract_transaction_status(transaction: &Event) -> Option<String> {
use relay_general::{
protocol::{Context, ContextInner},
types::Annotated,
Expand All @@ -49,6 +50,13 @@ fn transaction_status(transaction: &Event) -> Option<String> {
Some(span_status.to_string())
}

#[cfg(feature = "processing")]
fn extract_dist(transaction: &Event) -> Option<String> {
let mut dist = transaction.dist.0.clone();
normalize_dist(&mut dist);
dist
}

#[cfg(feature = "processing")]
pub fn extract_transaction_metrics(
config: &TransactionMetricsConfig,
Expand Down Expand Up @@ -90,6 +98,9 @@ pub fn extract_transaction_metrics(
if let Some(release) = event.release.as_str() {
tags.insert("release".to_owned(), release.to_owned());
}
if let Some(dist) = extract_dist(event) {
tags.insert("dist".to_owned(), dist);
}
if let Some(environment) = event.environment.as_str() {
tags.insert("environment".to_owned(), environment.to_owned());
}
Expand Down Expand Up @@ -182,7 +193,7 @@ pub fn extract_transaction_metrics(
unit: MetricUnit::Duration(DurationPrecision::MilliSecond),
value: MetricValue::Distribution(duration_millis as f64),
timestamp,
tags: match transaction_status(event) {
tags: match extract_transaction_status(event) {
Some(status) => with_tag(&tags, "transaction.status", status),
None => tags.clone(),
},
Expand Down Expand Up @@ -225,6 +236,7 @@ mod tests {
"type": "transaction",
"timestamp": "2021-04-26T08:00:00+0100",
"release": "1.2.3",
"dist": "foo ",
"environment": "fake_environment",
"transaction": "mytransaction",
"tags": {
Expand Down Expand Up @@ -311,6 +323,7 @@ mod tests {
for metric in metrics {
assert!(matches!(metric.value, MetricValue::Distribution(_)));
assert_eq!(metric.tags["release"], "1.2.3");
assert_eq!(metric.tags["dist"], "foo");
assert_eq!(metric.tags["environment"], "fake_environment");
assert_eq!(metric.tags["transaction"], "mytransaction");
assert_eq!(metric.tags["fOO"], "bar");
Expand Down Expand Up @@ -369,6 +382,7 @@ mod tests {
}

assert_eq!(duration_metric.tags.len(), 4);
assert_eq!(duration_metric.tags["release"], "1.2.3");
assert_eq!(duration_metric.tags["transaction.status"], "ok");
assert_eq!(duration_metric.tags["environment"], "fake_environment");
assert_eq!(duration_metric.tags["transaction"], "mytransaction");
Expand Down