Struct rtrtr::metrics::Target

pub struct Target { /* fields omitted */ }

A target for outputting metrics.

A new target can be created via new, passing in the requested output format. Individual metrics are appended to the target via append or the shortcut append_simple. Finally, when all metrics are assembled, you can turn the target into a string of the output via into_string.

Implementations

impl Target

pub fn new(format: OutputFormat) -> Self

Creates a new target.

The target will produce output in the given format.

pub fn into_string(self) -> String

Converts the target into a string with the assembled output.

pub fn append<F: FnOnce(&mut Records<'_>)>(
    &mut self,
    metric: &Metric,
    unit_name: Option<&str>,
    values: F
)

Appends metrics to the target.

The method can append multiple metrics values at once via the closure. All values are, however, for the same metrics described by metric. If the values are for a specific component, it’s name is given via unit_name. If they are global, this can be left at None.

pub fn append_simple(
    &mut self,
    metric: &Metric,
    unit_name: Option<&str>,
    value: impl Display
)

Append a single metric value to the target.

This is a shortcut version of append when there is only a single value to be append for a metric. The metric is described by metric. If the value is for a specific component, it’s name is given via unit_name. If they are global, this can be left at None.

Trait Implementations

impl Clone for Target

fn clone(&self) -> Target

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Target

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

Formats the value using the given formatter.