Trait snarkos_metrics::Recorder

pub trait Recorder {
    fn describe_counter(
        &self, 
        key: KeyName, 
        unit: Option<Unit>, 
        description: &'static str
    );
    fn describe_gauge(
        &self, 
        key: KeyName, 
        unit: Option<Unit>, 
        description: &'static str
    );
    fn describe_histogram(
        &self, 
        key: KeyName, 
        unit: Option<Unit>, 
        description: &'static str
    );
    fn register_counter(&self, key: &Key) -> Counter;
    fn register_gauge(&self, key: &Key) -> Gauge;
    fn register_histogram(&self, key: &Key) -> Histogram;
}

A trait for registering and recording metrics.

This is the core trait that allows interoperability between exporter implementations and the macros provided by metrics.

Required methods

fn describe_counter(
    &self,
    key: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

Describes a counter.

Callers may provide the unit or a description of the counter being registered. Whether or not a metric can be reregistered to provide a unit/description, if one was already passed or not, as well as how units/descriptions are used by the underlying recorder, is an implementation detail.

fn describe_gauge(
    &self,
    key: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

Describes a gauge.

Callers may provide the unit or a description of the gauge being registered. Whether or not a metric can be reregistered to provide a unit/description, if one was already passed or not, as well as how units/descriptions are used by the underlying recorder, is an implementation detail.

fn describe_histogram(
    &self,
    key: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

Describes a histogram.

Callers may provide the unit or a description of the histogram being registered. Whether or not a metric can be reregistered to provide a unit/description, if one was already passed or not, as well as how units/descriptions are used by the underlying recorder, is an implementation detail.

fn register_counter(&self, key: &Key) -> Counter

Registers a counter.

fn register_gauge(&self, key: &Key) -> Gauge

Registers a gauge.

fn register_histogram(&self, key: &Key) -> Histogram

Registers a histogram.

Implementations on Foreign Types

impl Recorder for PrometheusRecorder

pub fn describe_counter(
    &self,
    key_name: KeyName,
    _unit: Option<Unit>,
    description: &'static str
)

pub fn describe_gauge(
    &self,
    key_name: KeyName,
    _unit: Option<Unit>,
    description: &'static str
)

pub fn describe_histogram(
    &self,
    key_name: KeyName,
    _unit: Option<Unit>,
    description: &'static str
)

pub fn register_counter(&self, key: &Key) -> Counter

pub fn register_gauge(&self, key: &Key) -> Gauge

pub fn register_histogram(&self, key: &Key) -> Histogram

impl<R> Recorder for Stack<R> where
    R: Recorder, 

pub fn describe_counter(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn describe_gauge(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn describe_histogram(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn register_counter(&self, key: &Key) -> Counter

pub fn register_gauge(&self, key: &Key) -> Gauge

pub fn register_histogram(&self, key: &Key) -> Histogram

impl Recorder for Fanout

pub fn describe_counter(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn describe_gauge(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn describe_histogram(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn register_counter(&self, key: &Key) -> Counter

pub fn register_gauge(&self, key: &Key) -> Gauge

pub fn register_histogram(&self, key: &Key) -> Histogram

impl<R> Recorder for Prefix<R> where
    R: Recorder, 

pub fn describe_counter(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn describe_gauge(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn describe_histogram(
    &self,
    key_name: KeyName,
    unit: Option<Unit>,
    description: &'static str
)

pub fn register_counter(&self, key: &Key) -> Counter

pub fn register_gauge(&self, key: &Key) -> Gauge

pub fn register_histogram(&self, key: &Key) -> Histogram

Implementors

impl Recorder for NoopRecorder