Struct dipstick::InputMetric

pub struct InputMetric { /* private fields */ }

A metric is actually a function that knows to write a metric value to a metric output.

Implementations

impl InputMetric

pub fn new<F: Fn(MetricValue, Labels) + Send + Sync + 'static>(
    identifier: MetricId,
    metric: F
) -> InputMetric

Utility constructor

pub fn write(&self, value: MetricValue, labels: Labels)

Collect a new value for this metric.

Examples found in repository

examples/raw_log.rs (line 16)

pub fn raw_write() {
    // setup dual metric channels
    let metrics_log = dipstick::Log::to_log().metrics();

    // define and send metrics using raw channel API
    let counter = metrics_log.new_metric("count_a".into(), dipstick::InputKind::Counter);
    counter.write(1, labels![]);
}

pub fn metric_id(&self) -> &MetricId

Returns the unique identifier of this metric.

Trait Implementations

impl Clone for InputMetric

fn clone(&self) -> InputMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputMetric

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

Formats the value using the given formatter.

impl From<InputMetric> for Counter

fn from(metric: InputMetric) -> Counter

Converts to this type from the input type.

impl From<InputMetric> for Gauge

fn from(metric: InputMetric) -> Gauge

Converts to this type from the input type.

impl From<InputMetric> for Level

fn from(metric: InputMetric) -> Level

Converts to this type from the input type.

impl From<InputMetric> for Marker

fn from(metric: InputMetric) -> Marker

Converts to this type from the input type.

impl From<InputMetric> for Timer

fn from(metric: InputMetric) -> Timer

Converts to this type from the input type.