Struct dipstick::AppLabel

pub struct AppLabel;

Handle metric labels for the whole application (globals). App scope labels have the lowest lookup priority and serve as a fallback to other scopes.

Implementations

impl AppLabel

pub fn get(key: &str) -> Option<Arc<String>>

Retrieve a value from the app scope.

pub fn set<S: Into<String>>(key: S, value: S)

Set a new value for the app scope. Replaces any previous value for the key.

Examples found in repository

examples/text_format_label.rs (line 37)

fn main() {
    let counter = Stream::write_to_stderr()
        .formatting(MyFormat)
        .metrics()
        .counter("counter_a");
    AppLabel::set("abc", "xyz");
    loop {
        // report some metric values from our "application" loop
        counter.count(11);
        sleep(Duration::from_millis(500));
    }
}

examples/prometheus_labels.rs (line 12)

fn main() {
    let metrics = Prometheus::push_to("http://localhost:9091/metrics/job/prometheus_example")
        .expect("Prometheus Socket")
        .named("my_app")
        .metrics();

    AppLabel::set("abc", "456");
    ThreadLabel::set("xyz", "123");

    loop {
        metrics.counter("counter_a").count(123);
        metrics.timer("timer_a").interval_us(2000000);
        std::thread::sleep(Duration::from_millis(40));
    }
}

pub fn unset(key: &str)

Unset a value for the app scope. Has no effect if key was not set.