-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ref(spans): Introduce types for span metrics and tags (#2224)
Span metrics and types were initially introduced as a hard-coded way of directly typing strings. To avoid mistyping in the future, this PR introduces types so that there's no need to write strings. The approach it's pretty much the same as with transaction metrics, but a bit simpler due to less strict requirements.
- Loading branch information
1 parent
cedfbed
commit dcad1bd
Showing
2 changed files
with
202 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| use std::collections::BTreeMap; | ||
| use std::fmt::Display; | ||
|
|
||
| use chrono::Duration; | ||
| use relay_common::{DurationUnit, MetricUnit, UnixTimestamp}; | ||
| use relay_metrics::{Metric, MetricNamespace, MetricValue}; | ||
|
|
||
| use crate::metrics_extraction::IntoMetric; | ||
|
|
||
| #[derive(Clone, Debug)] | ||
| pub(crate) enum SpanMetric { | ||
| User { | ||
| value: String, | ||
| tags: BTreeMap<SpanTagKey, String>, | ||
| }, | ||
| Duration { | ||
| value: Duration, | ||
| tags: BTreeMap<SpanTagKey, String>, | ||
| }, | ||
| ExclusiveTime { | ||
| value: f64, | ||
| tags: BTreeMap<SpanTagKey, String>, | ||
| }, | ||
| } | ||
|
|
||
| impl IntoMetric for SpanMetric { | ||
| fn into_metric(self, timestamp: UnixTimestamp) -> Metric { | ||
| let namespace = MetricNamespace::Spans; | ||
|
|
||
| match self { | ||
| SpanMetric::User { value, tags } => Metric::new_mri( | ||
| namespace, | ||
| "user", | ||
| MetricUnit::None, | ||
| MetricValue::set_from_str(&value), | ||
| timestamp, | ||
| span_tag_mapping_to_string_mapping(tags), | ||
| ), | ||
| SpanMetric::Duration { value, tags } => Metric::new_mri( | ||
| namespace, | ||
| "duration", | ||
| MetricUnit::Duration(DurationUnit::MilliSecond), | ||
| MetricValue::Distribution(relay_common::chrono_to_positive_millis(value)), | ||
| timestamp, | ||
| span_tag_mapping_to_string_mapping(tags), | ||
| ), | ||
| SpanMetric::ExclusiveTime { value, tags } => Metric::new_mri( | ||
| namespace, | ||
| "exclusive_time", | ||
| MetricUnit::Duration(DurationUnit::MilliSecond), | ||
| MetricValue::Distribution(value), | ||
| timestamp, | ||
| span_tag_mapping_to_string_mapping(tags), | ||
| ), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Returns the same mapping of tags, with the tag keys as strings. | ||
| /// | ||
| /// Rust doesn't allow to add implementations on foreign methods (BTreeMap), so | ||
| /// this method is a workaround to parse [`SpanTagKey`]s to strings to strings. | ||
| fn span_tag_mapping_to_string_mapping( | ||
| tags: BTreeMap<SpanTagKey, String>, | ||
| ) -> BTreeMap<String, String> { | ||
| tags.into_iter().map(|(k, v)| (k.to_string(), v)).collect() | ||
| } | ||
|
|
||
| #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] | ||
| pub(crate) enum SpanTagKey { | ||
| // Specific to a transaction | ||
| Release, | ||
| User, | ||
| Environment, | ||
| Transaction, | ||
| TransactionMethod, | ||
| TransactionOp, | ||
| HttpStatusCode, | ||
|
|
||
| // Specific to spans | ||
| Description, | ||
| Group, | ||
| SpanOp, | ||
| Category, | ||
| Module, | ||
| Action, | ||
| Domain, | ||
| System, | ||
| Status, | ||
| StatusCode, | ||
| } | ||
|
|
||
| impl Display for SpanTagKey { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| let name = match self { | ||
| SpanTagKey::Release => "release", | ||
| SpanTagKey::User => "user", | ||
| SpanTagKey::Environment => "environment", | ||
| SpanTagKey::Transaction => "transaction", | ||
| SpanTagKey::TransactionMethod => "transaction.method", | ||
| SpanTagKey::TransactionOp => "transaction.op", | ||
| SpanTagKey::HttpStatusCode => "http.status_code", | ||
|
|
||
| SpanTagKey::Description => "span.description", | ||
| SpanTagKey::Group => "span.group", | ||
| SpanTagKey::SpanOp => "span.op", | ||
| SpanTagKey::Category => "span.category", | ||
| SpanTagKey::Module => "span.module", | ||
| SpanTagKey::Action => "span.action", | ||
| SpanTagKey::Domain => "span.domain", | ||
| SpanTagKey::System => "span.system", | ||
| SpanTagKey::Status => "span.status", | ||
| SpanTagKey::StatusCode => "span.status_code", | ||
| }; | ||
| write!(f, "{name}") | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use std::collections::BTreeMap; | ||
|
|
||
| use chrono::{TimeZone, Utc}; | ||
| use relay_common::UnixTimestamp; | ||
|
|
||
| use crate::metrics_extraction::spans::types::{SpanMetric, SpanTagKey}; | ||
| use crate::metrics_extraction::IntoMetric; | ||
|
|
||
| #[test] | ||
| fn test_span_metric_conversion() { | ||
| let timestamp = | ||
| UnixTimestamp::from_datetime(Utc.with_ymd_and_hms(2000, 1, 1, 0, 0, 0).unwrap()) | ||
| .unwrap(); | ||
|
|
||
| let tags = BTreeMap::from([(SpanTagKey::Release, "1.2.3".to_owned())]); | ||
| let metric = SpanMetric::User { | ||
| value: "usertag".to_owned(), | ||
| tags, | ||
| }; | ||
| let converted = metric.into_metric(timestamp); | ||
|
|
||
| insta::assert_debug_snapshot!(converted, @r#" | ||
| Metric { | ||
| name: "s:spans/user@none", | ||
| value: Set( | ||
| 1473472266, | ||
| ), | ||
| timestamp: UnixTimestamp(946684800), | ||
| tags: { | ||
| "release": "1.2.3", | ||
| }, | ||
| } | ||
| "#); | ||
| } | ||
| } |