faucet-cli 1.11.0

//! `faucet_serve_trigger_*` metrics. Low-cardinality labels only (`trigger`
//! name, `type`). Mirrors `crate::schedule::metrics`.

use metrics::{counter, describe_counter, describe_gauge, gauge};

pub fn describe() {
    describe_counter!(
        "faucet_serve_triggers_fired_total",
        "Events that warranted a fire, by trigger/type"
    );
    describe_counter!(
        "faucet_serve_trigger_runs_enqueued_total",
        "Fires that enqueued a run"
    );
    describe_counter!(
        "faucet_serve_trigger_runs_coalesced_total",
        "Fires deduped/coalesced (idempotency/debounce)"
    );
    describe_counter!(
        "faucet_serve_trigger_runs_dropped_total",
        "Fires dropped (e.g. queue_full)"
    );
    describe_counter!(
        "faucet_serve_trigger_errors_total",
        "Watcher poll/serve/fire errors"
    );
    describe_gauge!(
        "faucet_serve_triggers_active",
        "Number of active triggers (including webhook routes, which spawn no watcher task)"
    );
    describe_gauge!(
        "faucet_serve_trigger_healthy",
        "1 if the watcher is healthy, else 0"
    );
    describe_gauge!(
        "faucet_serve_trigger_last_fire_unix_seconds",
        "Unix time of the watcher's last fire"
    );
}

pub fn active(n: usize) {
    gauge!("faucet_serve_triggers_active").set(n as f64);
}

/// Pre-emit every per-trigger series at zero so they exist in `/metrics` from
/// startup — the `metrics` exporter only renders a series after its first
/// emission, so otherwise a pre-first-fire scrape shows "no data" for the
/// trigger. Mirrors `schedule::metrics`' pre-emit step. Called once per enabled
/// trigger from `spawn_watchers` (including webhooks, which spawn no task).
/// `last_fire` is intentionally NOT pre-emitted — there has been no fire yet.
pub fn preinit(trigger: &str, kind: &'static str) {
    counter!("faucet_serve_triggers_fired_total", "trigger" => trigger.to_string(), "type" => kind)
        .increment(0);
    counter!("faucet_serve_trigger_runs_enqueued_total", "trigger" => trigger.to_string())
        .increment(0);
    counter!("faucet_serve_trigger_runs_coalesced_total", "trigger" => trigger.to_string())
        .increment(0);
    counter!("faucet_serve_trigger_runs_dropped_total", "trigger" => trigger.to_string(), "reason" => "queue_full")
        .increment(0);
    counter!("faucet_serve_trigger_errors_total", "trigger" => trigger.to_string(), "type" => kind)
        .increment(0);
    healthy(trigger, true);
}
pub fn fired(trigger: &str, kind: &'static str) {
    counter!("faucet_serve_triggers_fired_total", "trigger" => trigger.to_string(), "type" => kind)
        .increment(1);
}
pub fn enqueued(trigger: &str) {
    counter!("faucet_serve_trigger_runs_enqueued_total", "trigger" => trigger.to_string())
        .increment(1);
}
pub fn coalesced(trigger: &str) {
    counter!("faucet_serve_trigger_runs_coalesced_total", "trigger" => trigger.to_string())
        .increment(1);
}
pub fn dropped(trigger: &str, reason: &'static str) {
    counter!("faucet_serve_trigger_runs_dropped_total", "trigger" => trigger.to_string(), "reason" => reason).increment(1);
}
pub fn error(trigger: &str, kind: &'static str) {
    counter!("faucet_serve_trigger_errors_total", "trigger" => trigger.to_string(), "type" => kind)
        .increment(1);
}
pub fn healthy(trigger: &str, ok: bool) {
    gauge!("faucet_serve_trigger_healthy", "trigger" => trigger.to_string()).set(if ok {
        1.0
    } else {
        0.0
    });
}
pub fn last_fire(trigger: &str, unix_secs: i64) {
    gauge!("faucet_serve_trigger_last_fire_unix_seconds", "trigger" => trigger.to_string())
        .set(unix_secs as f64);
}

#[cfg(test)]
mod tests {
    use super::*;
    use metrics::with_local_recorder;
    use metrics_util::debugging::{DebuggingRecorder, Snapshotter};

    #[test]
    fn emits_fired_counter() {
        let recorder = DebuggingRecorder::new();
        let snap: Snapshotter = recorder.snapshotter();
        with_local_recorder(&recorder, || {
            fired("t", "webhook");
        });
        let metrics = snap.snapshot().into_vec();
        assert!(
            metrics
                .iter()
                .any(|(k, _, _, _)| k.key().name() == "faucet_serve_triggers_fired_total"),
            "fired counter not emitted"
        );
    }

    #[test]
    fn preinit_emits_every_per_trigger_series_at_zero() {
        let recorder = DebuggingRecorder::new();
        let snap: Snapshotter = recorder.snapshotter();
        with_local_recorder(&recorder, || {
            preinit("t", "webhook");
        });
        let metrics = snap.snapshot().into_vec();
        let names: std::collections::BTreeSet<_> =
            metrics.iter().map(|(k, _, _, _)| k.key().name()).collect();
        for expected in [
            "faucet_serve_triggers_fired_total",
            "faucet_serve_trigger_runs_enqueued_total",
            "faucet_serve_trigger_runs_coalesced_total",
            "faucet_serve_trigger_runs_dropped_total",
            "faucet_serve_trigger_errors_total",
            "faucet_serve_trigger_healthy",
        ] {
            assert!(
                names.contains(expected),
                "preinit missing series {expected}"
            );
        }
        // last_fire must NOT be pre-emitted (no fire yet).
        assert!(
            !names.contains("faucet_serve_trigger_last_fire_unix_seconds"),
            "last_fire must not be pre-emitted"
        );
    }
}