Trait Metrics

pub trait Metrics:
    Clone
    + Send
    + Sync
    + 'static {
    // Required methods
    fn with_label(&self, label: &str) -> Self;
    fn label(&self) -> String;
    fn register<N: Into<String>, H: Into<String>>(
        &self,
        name: N,
        help: H,
        metric: impl Metric,
    );
    fn encode(&self) -> String;
}

Interface to register and encode metrics.

Required Methods

fn with_label(&self, label: &str) -> Self

Create a new instance of Metrics with the given label appended to the end of the current Metrics label.

This is commonly used to create a nested context for register.

It is not permitted for any implementation to use METRICS_PREFIX as the start of a label (reserved for metrics for the runtime).

fn label(&self) -> String

Get the current label of the context.

fn register<N: Into<String>, H: Into<String>>( &self, name: N, help: H, metric: impl Metric, )

Register a metric with the runtime.

Any registered metric will include (as a prefix) the label of the current context.

fn encode(&self) -> String

Encode all metrics into a buffer.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Metrics for commonware_runtime::deterministic::Context

impl Metrics for commonware_runtime::tokio::Context