docs: generate the metrics reference and bring the config reference to v1.6.5 - #2701
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
palfrey
requested changes
Aug 20, 2026
amankrx
force-pushed
the
docs/reference-generators
branch
from
August 20, 2026 16:09
5605291 to
1a5bfad
Compare
amankrx
force-pushed
the
docs/reference-generators
branch
from
August 20, 2026 16:31
1a5bfad to
4fe2afd
Compare
palfrey
approved these changes
Aug 20, 2026
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
2 participants
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.
What and why
Adds a generated metrics reference:
gen-metrics-reference.mjsparses every OpenTelemetry instrument out ofnativelink-util/src/metrics.rsand scans the workspace for its call sites, so the page states for each of the 30 instruments whether the binary actually emits it, under what condition, and which Prometheus series it becomes. Two small fixes to the existing generators ride along: the changelog page no longer puts a link inside each release heading (Fumadocs wraps headings in their own anchor, and the nested broke hydration), and the config-reference generator stops listing index in the folder'smeta.json(Fumadocs then uses the index page as the folder link instead of showing it twice) and skips manifest entries for tags that have no page. Also a Shiki alias so starlark code fences highlight.How was this verified?
Ran all three generators against this checkout and built the docs app (
bun run build, 58 pages). Spot-checked the metrics page's "emitted" verdicts against the call sites in the scheduler, worker-API, store-tier, health and connection code; the two "never emitted" instruments (cache.size,cache.entries) match the known gap in the shipped recording rules. Confirmed the changelog page renders without the hydration error.schema-to-mdx.mjsis untouched, and no committed generated page is changed in this PR: the next config-reference run should diff only themeta.jsonline. Vale and the pre-commit hooks pass over the changed files.Risk
Low. New script and new page, plus behaviour changes in two generators that only show up on their next run (one
meta.jsonline; a manifest that omits dead versions). The metrics page links to/operate/observability, which lands with the content PR; until then that link 404s.gen:metrics-referenceis not yet wired into the config-reference workflow, so the page can drift from metrics.rs until someone re-runs it.This change is