docs: document gcscore, gcwhy, and gcprofile extensions#157
Merged
Conversation
Documents the three new GC monitoring capabilities landed in this
cycle:
- argus gcscore — one-page GC Health Score Card with A–F grade and
hints (#150)
- argus gcwhy — narrative explanation of the worst recent GC pause
over a lookback window (#151)
- argus gcprofile — allocation profiler extended with --by=class and
--fold=FILE for flamegraph.pl rendering (#152)
Updates:
- README.md: Memory & GC command table gains three rows
- docs/cli-commands.md: new dedicated sections placed after argus
gclog, each with usage, axes/rules table, and design lineage
(GCeasy / Censum / async-profiler / JDK Mission Control)
Signed-off-by: rlaope <piyrw9754@gmail.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
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.
Follow-up documentation pass for the three GC-monitoring features merged this cycle.
Summary
argus gcscore,argus gcwhy, and an updatedargus gcprofileline highlighting the new--by=classand--fold=FILEmodes.docs/cli-commands.mdgains three dedicated sections placed afterargus gclog, each with usage examples, axes/rules tables, and design lineage (GCeasy / Censum / async-profiler / JDK Mission Control).References
argus gcscoreargus gcwhyargus gcprofile--by=class+--foldTest plan
grepconfirms new commands land in both files