Struct vector::event::Metric

pub struct Metric { /* private fields */ }

A metric.

Implementations

impl Metric

pub fn new<T>(name: T, kind: MetricKind, value: MetricValue) -> Metric

where T: Into<String>,

Creates a new Metric with the given name, kind, and value.

pub fn new_with_metadata<T>( name: T, kind: MetricKind, value: MetricValue, metadata: EventMetadata, ) -> Metric

where T: Into<String>,

Creates a new Metric with the given name, kind, value, and metadata.

pub fn with_name(self, name: impl Into<String>) -> Metric

Consumes this metric, returning it with an updated series based on the given name.

pub fn with_namespace<T>(self, namespace: Option<T>) -> Metric

where T: Into<String>,

Consumes this metric, returning it with an updated series based on the given namespace.

pub fn with_timestamp(self, timestamp: Option<DateTime<Utc>>) -> Metric

Consumes this metric, returning it with an updated timestamp.

pub fn with_interval_ms(self, interval_ms: Option<NonZero<u32>>) -> Metric

Consumes this metric, returning it with an updated interval.

pub fn add_finalizer(&mut self, finalizer: EventFinalizer)

pub fn with_batch_notifier(self, batch: &BatchNotifier) -> Metric

Consumes this metric, returning it with an updated set of event finalizers attached to batch.

pub fn with_batch_notifier_option(self, batch: &Option<BatchNotifier>) -> Metric

Consumes this metric, returning it with an optionally updated set of event finalizers attached to batch.

pub fn with_tags(self, tags: Option<MetricTags>) -> Metric

Consumes this metric, returning it with an updated series based on the given tags.

pub fn with_value(self, value: MetricValue) -> Metric

Consumes this metric, returning it with an updated value.

pub fn series(&self) -> &MetricSeries

Gets a reference to the series of this metric.

The “series” is the name of the metric itself, including any tags. In other words, it is the unique identifier for a metric, although metrics of different values (counter vs gauge) may be able to co-exist in outside metrics implementations with identical series.

pub fn data(&self) -> &MetricData

Gets a reference to the data of this metric.

pub fn data_mut(&mut self) -> &mut MetricData

Gets a mutable reference to the data of this metric.

pub fn metadata(&self) -> &EventMetadata

Gets a reference to the metadata of this metric.

pub fn metadata_mut(&mut self) -> &mut EventMetadata

Gets a mutable reference to the metadata of this metric.

pub fn name(&self) -> &str

Gets a reference to the name of this metric.

The name of the metric does not include the namespace or tags.

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

Gets a reference to the namespace of this metric, if it exists.

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

Takes the namespace out of this metric, if it exists, leaving it empty.

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

Gets a reference to the tags of this metric, if they exist.

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

Gets a mutable reference to the tags of this metric, if they exist.

pub fn timestamp(&self) -> Option<DateTime<Utc>>

Gets a reference to the timestamp of this metric, if it exists.

pub fn interval_ms(&self) -> Option<NonZero<u32>>

Gets a reference to the interval (in milliseconds) covered by this metric, if it exists.

pub fn value(&self) -> &MetricValue

Gets a reference to the value of this metric.

pub fn value_mut(&mut self) -> &mut MetricValue

Gets a mutable reference to the value of this metric.

pub fn kind(&self) -> MetricKind

Gets the kind of this metric.

pub fn time(&self) -> MetricTime

Gets the time information of this metric.

pub fn into_parts(self) -> (MetricSeries, MetricData, EventMetadata)

Decomposes a Metric into its individual parts.

pub fn from_parts( series: MetricSeries, data: MetricData, metadata: EventMetadata, ) -> Metric

Creates a Metric directly from the raw components of another metric.

pub fn into_absolute(self) -> Metric

Consumes this metric, returning it as an absolute metric.

If the metric was already absolute, nothing is changed.

pub fn into_incremental(self) -> Metric

Consumes this metric, returning it as an incremental metric.

If the metric was already incremental, nothing is changed.

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

Removes a tag from this metric, returning the value of the tag if the tag was previously in the metric.

pub fn remove_tags(&mut self)

Removes all the tags.

pub fn tag_matches(&self, name: &str, value: &str) -> bool

Returns true if name tag is present, and matches the provided value

pub fn tag_value(&self, name: &str) -> Option<String>

Returns the string value of a tag, if it exists

pub fn replace_tag(&mut self, name: String, value: String) -> Option<String>

Inserts a tag into this metric.

If the metric did not have this tag, None will be returned. Otherwise, Some(String) will be returned, containing the previous value of the tag.

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

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

pub fn zero(&mut self)

Zeroes out the data in this metric.

pub fn add(&mut self, other: impl AsRef<MetricData>) -> bool

Adds the data from the other metric to this one.

The other metric must be incremental and contain the same value type as this one.

pub fn update(&mut self, other: impl AsRef<MetricData>) -> bool

Updates this metric by adding the data from other.

pub fn subtract(&mut self, other: impl AsRef<MetricData>) -> bool

Subtracts the data from the other metric from this one.

The other metric must contain the same value type as this one.

pub fn reduce_tags_to_single(&mut self)

Reduces all the tag values to their single value, discarding any for which that value would be null. If the result is empty, the tag set is dropped.

Trait Implementations

impl AsRef<MetricData> for Metric

fn as_ref(&self) -> &MetricData

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MetricValue> for Metric

fn as_ref(&self) -> &MetricValue

Converts this type into a shared reference of the (usually inferred) input type.

impl ByteSizeOf for Metric

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 Metric

fn clone(&self) -> Metric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for Metric

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 Metric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Metric

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

Display a metric using something like Prometheus’ text format:

TIMESTAMP NAMESPACE_NAME{TAGS} KIND DATA

TIMESTAMP is in ISO 8601 format with UTC time zone.

KIND is either = for absolute metrics, or + for incremental metrics.

DATA is dependent on the type of metric, and is a simplified representation of the data contents. In particular, distributions, histograms, and summaries are represented as a list of X@Y words, where X is the rate, count, or quantile, and Y is the value or bucket.

example:

2020-08-12T20:23:37.248661343Z vector_received_bytes_total{component_kind="sink",component_type="blackhole"} = 6391

impl EstimatedJsonEncodedSizeOf for Metric

fn estimated_json_encoded_size_of(&self) -> JsonSize

impl EventContainer for Metric

type IntoIter = Once<Event>

The type of Iterator used to turn this container into events.

fn len(&self) -> usize

The number of events in this container.

fn is_empty(&self) -> bool

Is this container empty?

fn into_events(self) -> <Metric as EventContainer>::IntoIter

Turn this container into an iterator over Event.

impl EventDataEq for Metric

fn event_data_eq(&self, other: &Metric) -> bool

impl Finalizable for Metric

fn take_finalizers(&mut self) -> EventFinalizers

Consumes the finalizers of this object.

impl<'a> From<&'a Metric> for EventRef<'a>

fn from(metric: &'a Metric) -> EventRef<'a>

Converts to this type from the input type.

impl<'a> From<&'a mut Metric> for EventMutRef<'a>

fn from(metric: &'a mut Metric) -> EventMutRef<'a>

Converts to this type from the input type.

impl From<Metric> for Event

fn from(metric: Metric) -> Event

Converts to this type from the input type.

impl From<Metric> for EventArray

fn from(metric: Metric) -> EventArray

Converts to this type from the input type.

impl From<Metric> for Metric

fn from(metric: Metric) -> Metric

Converts to this type from the input type.

impl From<Metric> for Metric

fn from(metric: Metric) -> Metric

Converts to this type from the input type.

impl From<Metric> for WithMetadata<Metric>

fn from(metric: Metric) -> WithMetadata<Metric>

Converts to this type from the input type.

impl FromLua for Metric

fn from_lua(value: Value, _: &Lua) -> Result<Metric, Error>

Performs the conversion.

impl GetEventCountTags for Metric

fn get_tags(&self) -> TaggedEventsSent

impl PartialEq for Metric

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

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 Metric

fn to_value(&self) -> Value

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

impl StructuralPartialEq for Metric