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.

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

Expand gc-stats help #28

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Expand gc-stats help #28

merged 3 commits into from
Oct 24, 2023

Conversation

ju-sh
Copy link
Contributor

@ju-sh ju-sh commented Oct 21, 2023

Add information about gc-stats to --help command, using information already present in the README.

Made as part of OCaml hack event at Chennai on Oct 21st.

With help from Siva.

@ju-sh
Copy link
Contributor Author

ju-sh commented Oct 21, 2023

What more can be added to this? I guess examples from the README needs to be.

We shouldn't be adding them as such, right?

bin/olly.ml Outdated
@@ -345,7 +345,7 @@ let () =
`Blocks help_secs;
]
in
let doc = "Report the GC latency profile and stats." in
let doc = "Report the GC latency profile and stats. Total time spent by the program performing garbage collection (major and minor)" in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @ju-sh! You can possibly add the metrics and descriptions mentioned here: https://github.com/tarides/runtime_events_tools#gc-stats

@ju-sh
Copy link
Contributor Author

ju-sh commented Oct 23, 2023

Copy-pasted some info from README to gc-stats subcommand's help message.

olly gc-stats --help now shows:

...
...
SYNOPSIS
       olly gc-stats [--json] [--output=output] [OPTION]… EXECUTABLE

DESCRIPTION
       Report the GC latency profile.

       Wall time
           Real execution time of the program

       CPU time
           Total CPU time across all domains

       GC time
           Total time spent by the program performing garbage collection
           (major and minor)

       GC overhead
           Percentage of time taken up by GC against the total execution time

       GC time per domain
           Time spent by every domain performing garbage collection (major and
           minor cycles). Domains are reported with their domain ID (e.g.
           `Domain0`)

       GC latency profile
           Mean, standard deviation and percentile latency profile of GC
           events.

ARGUMENTS
       EXECUTABLE (required)
           Executable (and its arguments) to trace. If the executable takes
...
...

Is it better?

@Sudha247
Copy link
Member

Thanks! This looks good to me.

@Sudha247 Sudha247 marked this pull request as ready for review October 24, 2023 11:24
@Sudha247 Sudha247 merged commit aafefc1 into tarides:main Oct 24, 2023
1 of 2 checks passed
tmcgilchrist added a commit to tmcgilchrist/opam-repository that referenced this pull request Feb 27, 2024
CHANGES:

* Fix support on ARM64 platforms (Linux and MacOS) (tarides/runtime_events_tools#34, @tmcgilchrist)
* Remove ocamlfind dependency. (tarides/runtime_events_tools#36, @tmcgilchrist)
* Expand gc-stats help (tarides/runtime_events_tools#28, @ju-sh)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants