Repository navigation
docs(runbook): say why the Rules page counts one more than we do - #303
Merged
Merged
Conversation
Step 2 of the post-deploy check says "56 rules loaded, none in error", and the page it points at lists 57. The extra is `homelab_suricata_expected_interface`, the stack's only recording rule; every count in this repository — README, docs/observability.md, scripts/check_docs.py — is alert rules. The mismatch is not new. The line said 53 when the page showed 54, and 39 when it showed 40. It has been off by exactly one recording rule since that rule was added, which is the least useful kind of wrong: an operator following the runbook after a deploy finds a number that does not match and has no way to tell whether that is the discrepancy or a real one. Kept as "56 rules loaded" so scripts/check_docs.py still reads the claim — it matches on that phrase, and burying the count in prose would silently retire the check. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found while verifying the #114 deploy:
docs/runbooks/deploy-stack.mdstep 2says "56 rules loaded, none in error", and Prometheus' Rules page shows 57.
The extra one is
homelab_suricata_expected_interface, the stack's onlyrecording rule. Everything this repository counts is alert rules.
This is pre-existing rather than something #114 introduced — the line said 53
when the page showed 54, and 39 when it showed 40. But it is the least useful
kind of wrong: an operator running the post-deploy check finds a number that
does not match and cannot tell whether that is this discrepancy or a real one.
Kept as "56 rules loaded" rather than rephrased, because
scripts/check_docs.pymatches on exactly that phrase and moving the count into prose would retire the
check without saying so — the failure mode
docs/observability.mdwarns abouttwo paragraphs below its own count.
Verified:
./scripts/check_docs.pystill reads the claim (docs OK — 56 Prometheus + 16 Loki rules), and markdownlint passes.🤖 Generated with Claude Code