Skip to main content

describe_counter

Macro describe_counter 

Source
macro_rules! describe_counter {
    ($name:expr, $unit:expr, $description:expr $(,)?) => { ... };
    ($name:expr, $description:expr $(,)?) => { ... };
}
Expand description

Describes a counter.

Counters represent a single monotonic value, which means the value can only be incremented, not decremented, and always starts out with an initial value of zero.

Counters can be described with a free-form string, and optionally, a unit can be provided to describe the value and/or rate of the measurements. Whether or not the installed recorder does anything with the description, or optional unit, is implementation defined.

ยงExample

// A basic counter:
describe_counter!("some_metric_name", "my favorite counter");

// Providing a unit for a counter:
describe_counter!("some_metric_name", Unit::Bytes, "my favorite counter");

// As mentioned in the documentation, metric names also can be owned strings, including ones
// generated at the callsite via things like `format!`:
let name = String::from("some_owned_metric_name");
describe_counter!(name, "my favorite counter");

describe_counter!(format!("{}_via_format", "name"), "my favorite counter");