Struct MetricDefinition

#[non_exhaustive]
pub struct MetricDefinition {
    pub metric_definition_id: String,
    pub name: String,
    pub value_key: Option<String>,
    pub unit_label: Option<String>,
    pub dimension_keys: Option<HashMap<String, String>>,
    pub event_pattern: Option<String>,
    pub namespace: Option<String>,
}

A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

metric_definition_id: String

The ID of this metric definition.

name: String

The name of the metric that is defined in this structure.

value_key: Option<String>

The field within the event object that the metric value is sourced from.

unit_label: Option<String>

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

dimension_keys: Option<HashMap<String, String>>

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

event_pattern: Option<String>

The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

namespace: Option<String>

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

Implementations

impl MetricDefinition

pub fn metric_definition_id(&self) -> &str

The ID of this metric definition.

pub fn name(&self) -> &str

The name of the metric that is defined in this structure.

pub fn value_key(&self) -> Option<&str>

The field within the event object that the metric value is sourced from.

pub fn unit_label(&self) -> Option<&str>

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

pub fn dimension_keys(&self) -> Option<&HashMap<String, String>>

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

pub fn event_pattern(&self) -> Option<&str>

The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

pub fn namespace(&self) -> Option<&str>

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

impl MetricDefinition

pub fn builder() -> MetricDefinitionBuilder

Creates a new builder-style object to manufacture MetricDefinition.

Trait Implementations

impl Clone for MetricDefinition

fn clone(&self) -> MetricDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDefinition

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

Formats the value using the given formatter.

impl PartialEq for MetricDefinition

fn eq(&self, other: &MetricDefinition) -> 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 StructuralPartialEq for MetricDefinition