feat(spans): extract user.geo.geoscheme metrics

CHANGELOG.md

@@ -18,6 +18,7 @@
 - Introduce `trim = "disabled"` type attribute to prevent trimming of spans. ([#3877](https://github.com/getsentry/relay/pull/3877))
 - Make the tcp listen backlog configurable and raise the default to 1024. ([#3899](https://github.com/getsentry/relay/pull/3899))
 - Extract `user.geo.country_code` into span indexed. ([#3911](https://github.com/getsentry/relay/pull/3911))
+- Extract `user.geo.subregion` into span metrics/indexed. ([#3914](https://github.com/getsentry/relay/pull/3914))
 
 ## 24.7.1
 

relay-dynamic-config/src/defaults.rs

@@ -185,6 +185,8 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  let is_app_start = RuleCondition::glob("span.op", "app.start.*")
  & RuleCondition::eq("span.description", APP_START_ROOT_SPAN_DESCRIPTIONS);
 
+ let should_extract_geo = is_allowed_browser.clone() | is_mobile.clone() | is_resource.clone();
+
  // Metrics for addon modules are only extracted if the feature flag is enabled:
  let is_addon = is_ai.clone() | is_queue_op.clone() | is_cache.clone();
 
@@ -359,6 +361,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  Tag::with_key("browser.name")
  .from_field("span.browser.name")
  .always(), // already guarded by condition on metric
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .always(), // already guarded by condition on metric
  ],
  },
  MetricSpec {
@@ -382,6 +387,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  Tag::with_key("browser.name")
  .from_field("span.sentry_tags.browser.name")
  .always(), // already guarded by condition on metric
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .always(), // already guarded by condition on metric
  ],
  },
  MetricSpec {
@@ -405,6 +413,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  Tag::with_key("browser.name")
  .from_field("span.sentry_tags.browser.name")
  .always(), // already guarded by condition on metric
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .always(), // already guarded by condition on metric
  ],
  },
  MetricSpec {
@@ -428,6 +439,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  Tag::with_key("browser.name")
  .from_field("span.sentry_tags.browser.name")
  .always(), // already guarded by condition on metric
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .always(), // already guarded by condition on metric
  ],
  },
  MetricSpec {
@@ -630,6 +644,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  & duration_condition.clone(),
  ),
  // Know modules:
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .when(should_extract_geo.clone()),
  Tag::with_key("transaction.method")
  .from_field("span.sentry_tags.transaction.method")
  .when(is_db.clone() | is_mobile.clone() | is_http.clone()), // groups by method + txn, e.g. `GET /users`
@@ -715,6 +732,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  Tag::with_key("span.op")
  .from_field("span.sentry_tags.op")
  .always(),
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .when(should_extract_geo.clone()),
  // Mobile:
  Tag::with_key("device.class")
  .from_field("span.sentry_tags.device.class")
@@ -948,6 +968,9 @@ pub fn hardcoded_span_metrics() -> Vec<(GroupKey, Vec<MetricSpec>, Vec<TagMappin
  Tag::with_key("browser.name")
  .from_field("span.browser.name")
  .always(), // already guarded by condition on metric
+ Tag::with_key("user.geo.subregion")
+ .from_field("span.sentry_tags.user.geo.subregion")
+ .always(), // already guarded by condition on metric
  ],
  }],
  vec![],

relay-event-normalization/src/normalize/span/country_subregion.rs

@@ -0,0 +1,261 @@
+// country_subregion.rs
+use std::collections::HashMap;
+use std::fmt;
+
+/** Subregions regions as defined by UN M49 standards, the enum value corresponds to the region code */
+pub enum Subregion {
+ NorthernAmerica = 021,
+ CentralAmerica = 013,
+ Caribbean = 029,
+ SouthAmerica = 005,
+ NorthernEurope = 154,
+ WesternEurope = 155,
+ SouthernEurope = 039,
+ EasternEurope = 151,
+ EasternAsia = 030,
+ SouthernAsia = 034,
+ SouthEasternAsia = 035,
+ WesternAsia = 145,
+ CentralAsia = 143,
+ NorthernAfrica = 7,
+ WesternAfrica = 011,
+ MiddleAfrica = 017,
+ EasternAfrica = 014,
+ SouthernAfrica = 018,
+ Melanesia = 054,
+ Micronesia = 057,
+ Polynesia = 061,
+ AustraliaAndNewZealand = 053,
+}
+
+impl fmt::Display for Subregion {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let subregion_str = match self {
+ Subregion::NorthernAmerica => "Northern America",
+ Subregion::SouthAmerica => "Southern America",
+ Subregion::CentralAmerica => "Central America",
+ Subregion::Caribbean => "Caribbean",
+ Subregion::NorthernAfrica => "Northern Africa",
+ Subregion::SouthernEurope => "Southern Europe",
+ Subregion::WesternAsia => "Western Asia",
+ Subregion::EasternEurope => "Eastern Europe",
+ Subregion::EasternAsia => "Eastern Asia",
+ Subregion::SouthEasternAsia => "South-Eastern Asia",
+ Subregion::CentralAsia => "Central Asia",
+ Subregion::SouthernAsia => "Southern Asia",
+ Subregion::WesternEurope => "Western Europe",
+ Subregion::NorthernEurope => "Northern Europe",
+ Subregion::MiddleAfrica => "Middle Africa",
+ Subregion::WesternAfrica => "Western Africa",
+ Subregion::EasternAfrica => "Eastern Africa",
+ Subregion::SouthernAfrica => "Southern Africa",
+ Subregion::Melanesia => "Melanesia",
+ Subregion::Micronesia => "Micronesia",
+ Subregion::Polynesia => "Polynesia",
+ Subregion::AustraliaAndNewZealand => "Australia and New Zealand",
+ };
+ write!(f, "{}", subregion_str)
+ }
+}
+
+/**
+ * Maps ISO 2 letter country codes to geoscheme regions based on the UN M.49 standard.
+ */
+pub fn get_country_to_subregion() -> HashMap<&'static str, Subregion> {
+ HashMap::from([
+ ("AF", Subregion::SouthernAsia),
+ ("AL", Subregion::SouthernEurope),
+ ("DZ", Subregion::NorthernAfrica),
+ ("AS", Subregion::Polynesia),
+ ("AD", Subregion::SouthernEurope),
+ ("AO", Subregion::MiddleAfrica),
+ ("AG", Subregion::Caribbean),
+ ("AR", Subregion::SouthAmerica),
+ ("AM", Subregion::WesternAsia),
+ ("AU", Subregion::AustraliaAndNewZealand),
+ ("AT", Subregion::WesternEurope),
+ ("AZ", Subregion::WesternAsia),
+ ("BS", Subregion::Caribbean),
+ ("BH", Subregion::WesternAsia),
+ ("BD", Subregion::SouthernAsia),
+ ("BB", Subregion::Caribbean),
+ ("BY", Subregion::EasternEurope),
+ ("BE", Subregion::WesternEurope),
+ ("BZ", Subregion::CentralAmerica),
+ ("BJ", Subregion::WesternAfrica),
+ ("BM", Subregion::NorthernAmerica),
+ ("BT", Subregion::SouthernAsia),
+ ("BO", Subregion::SouthAmerica),
+ ("BA", Subregion::SouthernEurope),
+ ("BW", Subregion::SouthernAfrica),
+ ("BR", Subregion::SouthAmerica),
+ ("BN", Subregion::SouthEasternAsia),
+ ("BG", Subregion::EasternEurope),
+ ("BF", Subregion::WesternAfrica),
+ ("BI", Subregion::EasternAfrica),
+ ("CV", Subregion::WesternAfrica),
+ ("KH", Subregion::SouthEasternAsia),
+ ("CM", Subregion::MiddleAfrica),
+ ("CA", Subregion::NorthernAmerica),
+ ("KY", Subregion::Caribbean),
+ ("CF", Subregion::MiddleAfrica),
+ ("TD", Subregion::MiddleAfrica),
+ ("CL", Subregion::SouthAmerica),
+ ("CN", Subregion::EasternAsia),
+ ("CO", Subregion::SouthAmerica),
+ ("KM", Subregion::EasternAfrica),
+ ("CG", Subregion::MiddleAfrica),
+ ("CR", Subregion::CentralAmerica),
+ ("CI", Subregion::WesternAfrica),
+ ("HR", Subregion::SouthernEurope),
+ ("CU", Subregion::Caribbean),
+ ("CY", Subregion::WesternAsia),
+ ("CZ", Subregion::EasternEurope),
+ ("DK", Subregion::NorthernEurope),
+ ("DJ", Subregion::EasternAfrica),
+ ("DM", Subregion::Caribbean),
+ ("DO", Subregion::Caribbean),
+ ("EC", Subregion::SouthAmerica),
+ ("EG", Subregion::NorthernAfrica),
+ ("SV", Subregion::CentralAmerica),
+ ("GQ", Subregion::MiddleAfrica),
+ ("ER", Subregion::EasternAfrica),
+ ("EE", Subregion::NorthernEurope),
+ ("ET", Subregion::EasternAfrica),
+ ("FJ", Subregion::Melanesia),
+ ("FI", Subregion::NorthernEurope),
+ ("FR", Subregion::WesternEurope),
+ ("GA", Subregion::MiddleAfrica),
+ ("GM", Subregion::WesternAfrica),
+ ("GE", Subregion::WesternAsia),
+ ("DE", Subregion::WesternEurope),
+ ("GH", Subregion::WesternAfrica),
+ ("GR", Subregion::SouthernEurope),
+ ("GD", Subregion::Caribbean),
+ ("GT", Subregion::CentralAmerica),
+ ("GN", Subregion::WesternAfrica),
+ ("GW", Subregion::WesternAfrica),
+ ("GY", Subregion::SouthAmerica),
+ ("HT", Subregion::Caribbean),
+ ("HN", Subregion::CentralAmerica),
+ ("HU", Subregion::EasternEurope),
+ ("IS", Subregion::NorthernEurope),
+ ("IN", Subregion::SouthernAsia),
+ ("ID", Subregion::SouthEasternAsia),
+ ("IR", Subregion::SouthernAsia),
+ ("IQ", Subregion::WesternAsia),
+ ("IE", Subregion::NorthernEurope),
+ ("IL", Subregion::WesternAsia),
+ ("IT", Subregion::SouthernEurope),
+ ("JM", Subregion::Caribbean),
+ ("JP", Subregion::EasternAsia),
+ ("JO", Subregion::WesternAsia),
+ ("KZ", Subregion::CentralAsia),
+ ("KE", Subregion::EasternAfrica),
+ ("KI", Subregion::Micronesia),
+ ("KP", Subregion::EasternAsia),
+ ("KR", Subregion::EasternAsia),
+ ("KW", Subregion::WesternAsia),
+ ("KG", Subregion::CentralAsia),
+ ("LA", Subregion::SouthEasternAsia),
+ ("LV", Subregion::NorthernEurope),
+ ("LB", Subregion::WesternAsia),
+ ("LS", Subregion::SouthernAfrica),
+ ("LR", Subregion::WesternAfrica),
+ ("LY", Subregion::NorthernAfrica),
+ ("LI", Subregion::WesternEurope),
+ ("LT", Subregion::NorthernEurope),
+ ("LU", Subregion::WesternEurope),
+ ("MG", Subregion::EasternAfrica),
+ ("MW", Subregion::EasternAfrica),
+ ("MY", Subregion::SouthEasternAsia),
+ ("MV", Subregion::SouthernAsia),
+ ("ML", Subregion::WesternAfrica),
+ ("MT", Subregion::SouthernEurope),
+ ("MH", Subregion::Micronesia),
+ ("MR", Subregion::WesternAfrica),
+ ("MU", Subregion::EasternAfrica),
+ ("MX", Subregion::CentralAmerica),
+ ("FM", Subregion::Micronesia),
+ ("MD", Subregion::EasternEurope),
+ ("MC", Subregion::WesternEurope),
+ ("MN", Subregion::EasternAsia),
+ ("ME", Subregion::SouthernEurope),
+ ("MA", Subregion::NorthernAfrica),
+ ("MZ", Subregion::EasternAfrica),
+ ("MM", Subregion::SouthEasternAsia),
+ ("NA", Subregion::SouthernAfrica),
+ ("NR", Subregion::Micronesia),
+ ("NP", Subregion::SouthernAsia),
+ ("NL", Subregion::WesternEurope),
+ ("NZ", Subregion::AustraliaAndNewZealand),
+ ("NI", Subregion::CentralAmerica),
+ ("NE", Subregion::WesternAfrica),
+ ("NG", Subregion::WesternAfrica),
+ ("NO", Subregion::NorthernEurope),
+ ("OM", Subregion::WesternAsia),
+ ("PK", Subregion::SouthernAsia),
+ ("PW", Subregion::Micronesia),
+ ("PA", Subregion::CentralAmerica),
+ ("PG", Subregion::Melanesia),
+ ("PY", Subregion::SouthAmerica),
+ ("PE", Subregion::SouthAmerica),
+ ("PH", Subregion::SouthEasternAsia),
+ ("PL", Subregion::EasternEurope),
+ ("PT", Subregion::SouthernEurope),
+ ("QA", Subregion::WesternAsia),
+ ("RO", Subregion::EasternEurope),
+ ("RU", Subregion::EasternEurope),
+ ("RW", Subregion::EasternAfrica),
+ ("KN", Subregion::Caribbean),
+ ("LC", Subregion::Caribbean),
+ ("VC", Subregion::Caribbean),
+ ("WS", Subregion::Polynesia),
+ ("SM", Subregion::SouthernEurope),
+ ("ST", Subregion::MiddleAfrica),
+ ("SA", Subregion::WesternAsia),
+ ("SN", Subregion::WesternAfrica),
+ ("RS", Subregion::SouthernEurope),
+ ("SC", Subregion::EasternAfrica),
+ ("SL", Subregion::WesternAfrica),
+ ("SG", Subregion::SouthEasternAsia),
+ ("SK", Subregion::EasternEurope),
+ ("SI", Subregion::SouthernEurope),
+ ("SB", Subregion::Melanesia),
+ ("SO", Subregion::EasternAfrica),
+ ("ZA", Subregion::SouthernAfrica),
+ ("SS", Subregion::EasternAfrica),
+ ("ES", Subregion::SouthernEurope),
+ ("LK", Subregion::SouthernAsia),
+ ("SD", Subregion::NorthernAfrica),
+ ("SR", Subregion::SouthAmerica),
+ ("SZ", Subregion::SouthernAfrica),
+ ("SE", Subregion::NorthernEurope),
+ ("CH", Subregion::WesternEurope),
+ ("SY", Subregion::WesternAsia),
+ ("TJ", Subregion::CentralAsia),
+ ("TZ", Subregion::EasternAfrica),
+ ("TH", Subregion::SouthEasternAsia),
+ ("TL", Subregion::SouthEasternAsia),
+ ("TG", Subregion::WesternAfrica),
+ ("TO", Subregion::Polynesia),
+ ("TT", Subregion::Caribbean),
+ ("TN", Subregion::NorthernAfrica),
+ ("TR", Subregion::WesternAsia),
+ ("TM", Subregion::CentralAsia),
+ ("TV", Subregion::Polynesia),
+ ("UG", Subregion::EasternAfrica),
+ ("UA", Subregion::EasternEurope),
+ ("AE", Subregion::WesternAsia),
+ ("GB", Subregion::NorthernEurope),
+ ("US", Subregion::NorthernAmerica),
+ ("UY", Subregion::SouthAmerica),
+ ("UZ", Subregion::CentralAsia),
+ ("VU", Subregion::Melanesia),
+ ("VE", Subregion::SouthAmerica),
+ ("VN", Subregion::SouthEasternAsia),
+ ("YE", Subregion::WesternAsia),
+ ("ZM", Subregion::EasternAfrica),
+ ("ZW", Subregion::EasternAfrica),
+ ])
+}

relay-event-normalization/src/normalize/span/mod.rs

@@ -1,6 +1,7 @@
 //! Span normalization logic.
 
 pub mod ai;
+pub mod country_subregion;
 pub mod description;
 pub mod exclusive_time;
 pub mod tag_extraction;