Struct vector::event::metric::MetricName

pub struct MetricName {
    pub name: String,
    pub namespace: Option<String>,
}

Metric name.

Fields

name: String

The name of the metric.

This would typically be a name for the metric itself, unrelated to where the metric originates from. For example, if the metric represented the amount of used system memory, it may be called memory.used.

namespace: Option<String>

The namespace of the metric.

Namespace represents a grouping for a metric where the name itself may otherwise be too generic. For example, while the name of a metric may be memory.used for the amount of used system memory, the namespace could differentiate that by being system for the total amount of used memory across the system, or vector for the amount of used system memory specific to Vector, and so on.

Implementations

impl MetricName

pub fn name(&self) -> &str

Gets a reference to the name component of this name.

pub fn name_mut(&mut self) -> &mut String

Gets a mutable reference to the name component of this name.

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

Gets a reference to the namespace component of this name.

pub fn namespace_mut(&mut self) -> &mut Option<String>

Gets a mutable reference to the namespace component of this name.

Trait Implementations

impl ByteSizeOf for MetricName

fn allocated_bytes(&self) -> usize

Returns the allocated bytes of this type

fn size_of(&self) -> usize

Returns the in-memory size of this type

impl Clone for MetricName

fn clone(&self) -> MetricName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for MetricName

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for MetricName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricName

fn deserialize<__D>( __deserializer: __D, ) -> Result<MetricName, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MetricName

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

where __H: Hasher,

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 MetricName

fn cmp(&self, other: &MetricName) -> 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 MetricName

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

fn partial_cmp(&self, other: &MetricName) -> 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 MetricName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for MetricName

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl Eq for MetricName

impl StructuralPartialEq for MetricName