Enum relay_base_schema::metrics::MetricNamespace

pub enum MetricNamespace {
    Sessions,
    Transactions,
    Spans,
    Profiles,
    Custom,
    Stats,
    Unsupported,
}

The namespace of a metric.

Namespaces allow to identify the product entity that the metric got extracted from, and identify the use case that the metric belongs to. These namespaces cannot be defined freely, instead they are defined by Sentry. Over time, there will be more namespaces as we introduce new metrics-based functionality.

Parsing

Parsing a metric namespace from strings is infallible. Unknown strings are mapped to MetricNamespace::Unsupported. Metrics with such a namespace will be dropped.

Ingestion

During ingestion, the metric namespace is validated against a list of known and enabled namespaces. Metrics in disabled namespaces are dropped during ingestion.

At a later stage, namespaces are used to route metrics to their associated infra structure and enforce usecase-specific configuration.

Variants

Sessions

Metrics extracted from sessions.

Transactions

Metrics extracted from transaction events.

Spans

Metrics extracted from spans.

Profiles

Metrics extracted from profile functions.

Custom

User-defined metrics directly sent by SDKs and applications.

Stats

Metric stats.

Metrics about metrics.

Unsupported

An unknown and unsupported metric.

Metrics that Relay either doesn’t know or recognize the namespace of will be dropped before aggregating. For instance, an MRI of c:something_new/foo@none has the namespace something_new, but as Relay doesn’t support that namespace, it gets deserialized into this variant.

Relay currently drops all metrics whose namespace ends up being deserialized as unsupported. We may revise that in the future.

Implementations

impl MetricNamespace

pub fn all() -> [Self; 7]

Returns all namespaces/variants of this enum.

pub fn has_metric_stats(&self) -> bool

Returns true if metric stats are enabled for this namespace.

pub fn as_str(&self) -> &'static str

Returns the string representation for this metric type.

Trait Implementations

impl Clone for MetricNamespace

fn clone(&self) -> MetricNamespace

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricNamespace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricNamespace

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetricNamespace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for MetricNamespace

type Err = ParseMetricError

The associated error which can be returned from parsing.

fn from_str(ns: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MetricNamespace

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MetricNamespace

fn cmp(&self, other: &MetricNamespace) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MetricNamespace

fn eq(&self, other: &MetricNamespace) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MetricNamespace

fn partial_cmp(&self, other: &MetricNamespace) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetricNamespace

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MetricNamespace

impl Eq for MetricNamespace

impl StructuralPartialEq for MetricNamespace