Skip to content
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.

Sign up for GitHub

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

runtime/metrics: improve doc #72793

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+5 −5
Open

runtime/metrics: improve doc #72793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc81fad
Update runtime/metrics/doc.go, polish sentences by removing redundant…
Lslightly Jan 15, 2025
cd65f1d
update description.go and use go generate . to update doc.go
Lslightly Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/runtime/metrics/description.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ var allDesc = []Description{
{
Name: "/cpu/classes/scavenge/assist:cpu-seconds",
Description: "Estimated total CPU time spent returning unused memory to the " +
"underlying platform in response eagerly in response to memory pressure. " +
"underlying platform in response eagerly to memory pressure. " +
"This metric is an overestimate, and not directly comparable to " +
"system CPU time measurements. Compare only with other /cpu/classes " +
"metrics.",
Expand Down
8 changes: 4 additions & 4 deletions src/runtime/metrics/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ Below is the full list of supported metrics, ordered lexicographically.

/cpu/classes/scavenge/assist:cpu-seconds
Estimated total CPU time spent returning unused memory to the
underlying platform in response eagerly in response to memory
pressure. This metric is an overestimate, and not directly
comparable to system CPU time measurements. Compare only with
other /cpu/classes metrics.
underlying platform in response eagerly to memory pressure. This
metric is an overestimate, and not directly comparable to system
CPU time measurements. Compare only with other /cpu/classes
metrics.

/cpu/classes/scavenge/background:cpu-seconds
Estimated total CPU time spent performing background tasks to
Expand Down