docs(metrics): document eval metric name prefixing convention#950
Merged
docs(metrics): document eval metric name prefixing convention#950
Conversation
Add a "Metric Name Prefixing" section to the metrics reference
explaining how eval metric names are auto-prefixed with
{namespace}_eval_, the deduplication behavior that prevents
double-prefixing, and how the namespace is configured.
Includes PromQL examples for querying eval vs pipeline metrics.
Closes #948
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
1 participant
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.
Summary
Add "Metric Name Prefixing" section to the metrics reference explaining:
{namespace}_eval_CollectorOpts.Namespace)metricfield is definedAudit findings
The existing metrics docs are comprehensive — all 11 pipeline metrics are documented, eval metric types/labels/scoring are well-covered. The only gap was the prefixing convention, which was mentioned in passing (line 124: "auto-prefixed if not already") but never fully explained with examples.
No duplication issues found — the three docs pages (reference, how-to, SDK) each contextualize the same information appropriately for different audiences.
Closes #948