From 6f2f8739e196217e4732c63f32d1b11acf5eb456 Mon Sep 17 00:00:00 2001 From: Oreofe Date: Sun, 30 Aug 2026 21:47:10 +0100 Subject: [PATCH] docs: the metric families are populated now MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The caveat said flo_shard_* and the per-stream totals export as 0 because nothing recorded them on the write paths. That is no longer true — stream, queue, per-shard, workflow, processing, KV and tiered-log counters are all wired to their write paths now. The other half of the note still holds and stays: flo_cluster_nodes, flo_raft_leader_elections_total and flo_gossip_members are not implemented, so nobody should build a scrape config on them. Added the one remaining honest zero: flo_tiered_log_cold_hits_total is always 0 because the read path consults the hot ring and warm store only, never cold. Better stated than left for someone to interpret as a broken counter. --- docs/deployment/clustering.mdx | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/deployment/clustering.mdx b/docs/deployment/clustering.mdx index f0f73b3..7a2b0f0 100644 --- a/docs/deployment/clustering.mdx +++ b/docs/deployment/clustering.mdx @@ -200,11 +200,14 @@ Divergence detection is implemented; automatic repair is not — see ::: :::note -**Some families are registered but not yet incremented.** Nothing records the -per-shard or per-stream counters on the write paths, so `flo_shard_*` and the -per-stream totals currently export as `0`. Cluster-level names such as -`flo_cluster_nodes`, `flo_raft_leader_elections_total` and `flo_gossip_members` -are not implemented at all. +**Cluster-level names such as `flo_cluster_nodes`, +`flo_raft_leader_elections_total` and `flo_gossip_members` are not +implemented** — do not build scrape configs or alerts on them. The families +documented above are populated from the live write paths. + +One exception worth knowing: `flo_tiered_log_cold_hits_total` is always `0`. +The read path consults the hot ring and the warm store only, so a cold-tier +read is never counted there rather than the counter being unwired. ::: ## Recommended Topologies