Struct VortexMetrics 

pub struct VortexMetrics { /* private fields */ }

A metric registry for various performance metrics.

Implementations

impl VortexMetrics

pub fn new( registry: MetricRegistry, default_tags: impl Into<DefaultTags>, ) -> Self

Create a new VortexMetrics instance.

pub fn new_with_tags(default_tags: impl Into<DefaultTags>) -> Self

Create an empty metric registry with default tags.

pub fn child_with_tags(&self, additional_tags: impl Into<DefaultTags>) -> Self

Create a new metrics registry with additional tags. Metrics created in the child registry will be included in this registry’s snapshots.

pub fn counter<T>(&self, id: T) -> Arc<Counter>

where T: Into<MetricId>,

Returns the counter with the specified ID, creating a default instance if absent.

Panics

Panics if a metric is registered with the ID that is not a counter.

pub fn histogram<T>(&self, id: T) -> Arc<Histogram>

where T: Into<MetricId>,

Returns the histogram with the specified ID, creating a default instance if absent.

Panics

Panics if a metric is registered with the ID that is not a histogram.

pub fn timer<T>(&self, id: T) -> Arc<Timer>

where T: Into<MetricId>,

Returns the timer with the specified ID, creating a default instance if absent.

Panics

Panics if a metric is registered with the ID that is not a timer.

pub fn snapshot(&self) -> MetricsSnapshot

Returns a snapshot of the metrics in the registry.

Modifications to the registry after this method is called will not affect the state of the returned MetricsSnapshot.

Note: Tag values may contain sensitive information and should be properly sanitized before external exposure.

Trait Implementations

impl Clone for VortexMetrics

fn clone(&self) -> VortexMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VortexMetrics

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

Formats the value using the given formatter.

impl Default for VortexMetrics

fn default() -> VortexMetrics

Returns the “default value” for a type.