Struct vector::event::metric::MetricSeries

pub struct MetricSeries {
    pub name: MetricName,
    pub tags: Option<MetricTags>,
}

Metrics series.

Fields

name: MetricName

tags: Option<MetricTags>

Implementations

impl MetricSeries

pub fn name(&self) -> &MetricName

Gets a reference to the name of the series.

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

Gets a mutable reference to the name of the series.

pub fn tags(&self) -> Option<&MetricTags>

Gets an optional reference to the tags of the series.

pub fn tags_mut(&mut self) -> &mut Option<MetricTags>

Gets an optional mutable reference to the tags of the series.

pub fn replace_tag( &mut self, key: String, value: impl Into<TagValue>, ) -> Option<String>

Sets or updates the string value of a tag.

Note: This will create the tags map if it is not present.

pub fn set_multi_value_tag( &mut self, key: String, values: impl IntoIterator<Item = TagValue>, )

pub fn remove_tags(&mut self)

Removes all the tags.

pub fn remove_tag(&mut self, key: &str) -> Option<String>

Removes the tag entry for the named key, if it exists, and returns the old value.

Note: This will drop the tags map if the tag was the last entry in it.

Trait Implementations

impl ByteSizeOf for MetricSeries

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 MetricSeries

fn clone(&self) -> MetricSeries

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for MetricSeries

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 MetricSeries

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricSeries

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetricSeries

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

Display a metric series name using something like Prometheus’ text format:

NAMESPACE_NAME{TAGS}

impl Hash for MetricSeries

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 MetricSeries

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for MetricSeries

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for MetricSeries

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 MetricSeries

fn to_value(&self) -> Value

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

impl Eq for MetricSeries

impl StructuralPartialEq for MetricSeries