Repository navigation
docs(observability): use one table format and mark stability in the Metrics Catalog #17922
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jh-nv
wants to merge
7
commits into
main
Choose a base branch
from
jihao/metrics-consolidation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+406
−606
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
30811d7
docs(observability): use one table format in the Metrics Catalog
jh-nv 5632f69
docs(observability): mark each metric's stability in the Metrics Catalog
jh-nv d328427
docs(observability): leave the status of stable metrics empty
jh-nv 95b27c4
Merge branch 'main' into jihao/metrics-consolidation
jh-nv 1ee7b0f
docs(observability): address Metrics Catalog review comments
jh-nv 5d17128
docs(observability): correct Metrics Catalog entries against the code
jh-nv 21452b6
Merge branch 'main' into jihao/metrics-consolidation
jh-nv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Align the description with the documented metric semantics.
The catalog defines this metric as mean task poll time in nanoseconds. It does not define “near 1 ms or more” as proof that the runtime is starved. Use the documented description, or add and validate this threshold in the Metrics Catalog before using it here.
As per coding guidelines, the Metrics Catalog is the source of truth for metric documentation.
Source: Coding guidelines