feat(health): KPI history + sustained-backlog badge for LocalDb replication (row 33)

LocalDbOplogBacklog was reported and Prometheus-exported with nothing consuming
it: not sampled into KPI history, so a purge-burst spike could not be reviewed
after the fact, and no threshold treatment anywhere. Both halves shipped.

KPI SAMPLING. SiteHealthKpiSampleSource now emits localDbOplogBacklog and
localDbReplicationConnected (0/1), and the backlog is charted on the Health
dashboard's per-site trend panel. Charting is the point: a point-in-time tile
can never answer 'did that spike drain?', which is the only thing separating an
expected purge burst from a stalled peer.

Both are CONDITIONALLY emitted rather than coerced with ?? 0 like the
auditBacklogPending metric beside them. Both health-report fields are nullable
and null means 'no reading' — replication not configured (rig site-b/site-c) or
a failed poll — never zero. A fabricated 0 would render a pair that cannot read
its own oplog, or one deliberately unreplicated, as perfectly healthy once a
minute forever, burying the real series. So a site emits 12 metrics when
unreplicated and 14 when replicated, and a GAP in these two series truthfully
means 'not replicated / not reporting'. Note false and null differ for the
connected flag: a configured link that is DOWN samples as 0; no link samples as
nothing. Both fold as Gauge (summing an oplog depth, or a 0/1 flag, per hour is
meaningless).

THRESHOLD SEMANTICS — sustained, not instantaneous. This is the design, not a
refinement. The site_events retention purge is CDC-captured like any other
write, so the backlog jumps by the deleted batch and drains as the peer acks
it; a bare 'backlog > threshold' badge would fire on every replicated site
every day and be ignored within a week. Healthy is defined by the backlog
RETURNING to ~0, which only a dwell can express. CentralHealthAggregator holds
LocalDbBacklogAboveSince — the instant the backlog first rose above
LocalDbBacklogThreshold (default 1000) — and the badge appears only after
LocalDbBacklogSustainedFor (default 15 min). A report at or below the threshold
clears the anchor; one above leaves the ORIGINAL instant intact, so the window
is sustained rather than sliding.

The null case is deliberately a third branch: a null backlog leaves the anchor
UNCHANGED rather than clearing it. Null is evidence neither of a drain nor of a
backlog, so a node going blind mid-climb must not silently reset its own dwell,
and an unreplicated site (null forever) never accumulates an anchor and can
never be badged.

Validation rejects a non-positive threshold (0 would badge every replicated site
permanently, since an idle backlog already sits at it) and a dwell shorter than
one ReportInterval (satisfiable by a single sample, which collapses the check
back into the bare threshold it replaces).

DOC CORRECTION worth flagging: this row's premise was 'mirror the SiteAuditBacklog
configurable threshold badge'. That badge does not exist — Component-HealthMonitoring.md
described it in two places but no option, no comparison and no markup were ever
implemented. The two stale claims are corrected here rather than left to send the
next reader looking for it; the LocalDb badge is built fresh on the Metrics-stale
badge's pattern, which is a real configurable-threshold badge.

Tests: HealthMonitoring 115 (9 new aggregator tests incl. purge-burst-drains,
unreplicated-never-anchors, null-mid-climb, exact-threshold, stale-report; 5 new
validator tests; 4 new sampler tests incl. the null-semantics and false-vs-null
cases); CentralUI 1042 (5 new badge/chart tests incl. the purge-burst negative
control); Commons Kpi 93; KpiHistory 54.
This commit is contained in:
Joseph Doherty
2026-08-15 13:02:35 -04:00
parent 0d2d6de6c6
commit 8da60f57ac
15 changed files with 711 additions and 6 deletions
@@ -346,6 +346,103 @@ public class HealthPageTests : BunitContext
});
}
// ------------------------------------------------------------------
// Sustained LocalDb replication backlog badge (register row 33)
// ------------------------------------------------------------------
[Fact]
public void Renders_ReplicationBacklogBadge_WhenBacklogSustainedPastTheDwell()
{
SeedStates(new SiteHealthState
{
SiteId = "site-a",
IsOnline = true,
LastHeartbeatAt = DateTimeOffset.UtcNow,
// Default dwell is 15 minutes; 30 minutes above threshold is well past it.
LocalDbBacklogAboveSince = DateTimeOffset.UtcNow.AddMinutes(-30),
});
var cut = RenderHealthPage();
cut.WaitForAssertion(() =>
{
Assert.Contains("data-test=\"localdb-backlog-badge\"", cut.Markup);
Assert.Contains("Replication backlog", cut.Markup);
});
}
[Fact]
public void DoesNotRender_ReplicationBacklogBadge_DuringAPurgeBurst()
{
// THE false-positive this badge is shaped to avoid. The daily site_events purge is
// CDC-captured, so the backlog spikes and then drains. Two minutes above the
// threshold is a purge burst, not a fault, and must stay silent — otherwise the
// badge fires on every replicated site every day and gets ignored.
SeedStates(new SiteHealthState
{
SiteId = "site-a",
IsOnline = true,
LastHeartbeatAt = DateTimeOffset.UtcNow,
LocalDbBacklogAboveSince = DateTimeOffset.UtcNow.AddMinutes(-2),
});
var cut = RenderHealthPage();
cut.WaitForAssertion(() => Assert.Contains("site-a", cut.Markup));
Assert.DoesNotContain("data-test=\"localdb-backlog-badge\"", cut.Markup);
}
[Fact]
public void DoesNotRender_ReplicationBacklogBadge_ForAnUnreplicatedSite()
{
// Rig site-b/site-c report a null backlog forever, so the aggregator never gives them
// an anchor. A deliberately-unreplicated site must never be badged.
SeedStates(new SiteHealthState
{
SiteId = "site-b",
IsOnline = true,
LastHeartbeatAt = DateTimeOffset.UtcNow,
LocalDbBacklogAboveSince = null,
});
var cut = RenderHealthPage();
cut.WaitForAssertion(() => Assert.Contains("site-b", cut.Markup));
Assert.DoesNotContain("data-test=\"localdb-backlog-badge\"", cut.Markup);
}
[Fact]
public void DoesNotRender_ReplicationBacklogBadge_ForAnOfflineSite()
{
// An offline site's last-known anchor is stale by definition; the Offline badge is the
// signal that matters, and stacking a backlog warning on top is noise.
SeedStates(new SiteHealthState
{
SiteId = "site-a",
IsOnline = false,
LastHeartbeatAt = DateTimeOffset.UtcNow.AddMinutes(-30),
LocalDbBacklogAboveSince = DateTimeOffset.UtcNow.AddMinutes(-30),
});
var cut = RenderHealthPage();
cut.WaitForAssertion(() => Assert.Contains("site-a", cut.Markup));
Assert.DoesNotContain("data-test=\"localdb-backlog-badge\"", cut.Markup);
}
[Fact]
public void Renders_LocalDbBacklogTrendChart()
{
// The retrospective half of row 33: a point-in-time tile can never answer "did that
// spike drain?", which is the only question that distinguishes healthy from faulty.
SeedSites("site-a");
var cut = RenderHealthPage();
cut.WaitForAssertion(() =>
Assert.Contains("LocalDb Replication Backlog", cut.Markup));
}
[Fact]
public void Renders_OfflineSince_ForOfflineSiteWithStatusChange()
{