Struct relay_dynamic_config::MetricExtractionConfig

pub struct MetricExtractionConfig {
    pub version: u16,
    pub global_groups: BTreeMap<String, MetricExtractionGroupOverride>,
    pub metrics: Vec<MetricSpec>,
    pub tags: Vec<TagMapping>,
    pub _conditional_tags_extended: bool,
    pub _span_metrics_extended: bool,
}

Configuration for generic extraction of metrics from all data categories.

Fields

version: u16

Versioning of metrics extraction. Relay skips extraction if the version is not supported.

global_groups: BTreeMap<String, MetricExtractionGroupOverride>

Configuration of global metric groups.

The groups themselves are configured in crate::GlobalConfig, but can be enabled or disabled here.

metrics: Vec<MetricSpec>

A list of metric specifications to extract.

tags: Vec<TagMapping>

A list of tags to add to previously extracted metrics.

These tags add further tags to a range of metrics. If some metrics already have a matching tag extracted, the existing tag is left unchanged.

_conditional_tags_extended: bool

This config has been extended with fields from conditional_tagging.

At the moment, Relay will parse conditional_tagging rules and insert them into the tags mapping in this struct. If the flag is true, this has already happened and should not be repeated.

This is a temporary flag that will be removed once the transaction metric extraction version is bumped to 2.

_span_metrics_extended: bool

This config has been extended with default span metrics.

Relay checks for the span extraction flag and adds built-in metrics and tags to this struct. If the flag is true, this has already happened and should not be repeated.

This is a temporary flag that will be removed once the transaction metric extraction version is bumped to 2.

Implementations

impl MetricExtractionConfig

pub const MAX_SUPPORTED_VERSION: u16 = 3u16

The latest version for this config struct.

This is the maximum version supported by this Relay instance.

pub fn empty() -> Self

Returns an empty MetricExtractionConfig with the latest version.

As opposed to default(), this will be enabled once populated with specs.

pub fn is_supported(&self) -> bool

Returns true if the version of this metric extraction config is supported.

pub fn is_enabled(&self) -> bool

Returns true if metric extraction is configured and compatible with this Relay.

Trait Implementations

impl Clone for MetricExtractionConfig

fn clone(&self) -> MetricExtractionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricExtractionConfig

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

Formats the value using the given formatter.

impl Default for MetricExtractionConfig

fn default() -> MetricExtractionConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricExtractionConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a MetricExtractionConfig> for CombinedMetricExtractionConfig<'a>

fn from(value: &'a MetricExtractionConfig) -> Self

Creates a combined config with an empty global component. Used in tests.

impl Serialize for MetricExtractionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.