packageruntime_events_tools
Tools for the runtime events tracing system in OCaml
Install
Dune Dependency
Authors
Maintainers
Sources
runtime_events_tools-0.5.1.tbz
sha256=b09d346a2e62b2ec15e8ca7ce921f1cecea01799bf1137dd6df40459d7656564sha512=c8bf22dc7ddeadfc4bbc5a263ad5355938b4763466eec3fbc7929440ed25e54abf56abb39bfe4f2f7e2a3daf83df983b840aaaff243fda447a46a145026c9a66Description
Various tools for the runtime events tracing system in OCaml
Published:27 Feb 2024
README
Runtime events tools
A collection of observability tools around the runtime events tracing system introduced in OCaml 5.0.
olly
olly provides a number of sub-commands.
gc-stats
olly gc-stats will report the GC running time and GC tail latency profile of an OCaml executable.
| Metric | Description |
|---|---|
| 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. |
$ olly gc-stats 'binarytrees.exe 19' # Use quotes for commands with argumentsExecution times:Wall time (s):2.01CPU time (s):5.73GC time (s):3.15GC overhead (% of CPU time):55.00%GC time per domain (s):Domain0: 1.15Domain1: 0.99Domain2: 1.01GC latency profile:#[Mean (ms):0.88, Stddev (ms):1.67]#[Min (ms):0.00, max (ms):13.21]Percentile Latency (ms)25.0000 0.0150.0000 0.0460.0000 0.1370.0000 0.4575.0000 0.7980.0000 1.5385.0000 2.4690.0000 3.4695.0000 4.3896.0000 5.0797.0000 5.8798.0000 6.4599.0000 7.0899.9000 11.2099.9900 13.2199.9990 13.2199.9999 13.21100.0000 13.21$ olly gc-stats 'menhir -v --table sysver.mly' # Use quotes for commands with arguments<snip>Execution times:Wall time (s):60.88CPU time (s):60.88GC time (s):7.30GC overhead (% of CPU time):11.99%GC time per domain (s):Domain0: 7.30GC latency profile:#[Mean (ms):0.10, Stddev (ms):0.43]#[Min (ms):0.00, max (ms):39.16]Percentile Latency (ms)25.0000 0.0050.0000 0.0060.0000 0.0070.0000 0.0075.0000 0.0080.0000 0.0085.0000 0.0190.0000 0.2695.0000 0.6996.0000 0.8897.0000 1.0498.0000 1.3099.0000 1.9199.9000 4.5699.9900 8.3199.9990 9.8399.9999 39.16100.0000 39.16trace
olly trace will record the runtime trace log inFuchsia trace format orChrome tracing format . Format of the trace file can be specified with the--format option. The default is Fuchsia trace format.
$ olly trace --format=fuchsia menhir_sysver.trace 'menhir -v --table sysver.mly' # Fuchsia trace format<snip>$ ls menhir_sysver.tracemenhir_sysver.trace$ olly trace --format=json menhir_sysver.trace 'menhir -v --table sysver.mly' # Chrome tracing format<snip>$ ls menhir_sysver.tracemenhir_sysver.traceTraces in either formats can be viewed inperfetto trace viewer. Chrome format trace can also be viewed inchrome://tracing in chromium-based browsers.
Dependencies
The library depends onhdr_histogram_ocaml.
Dependencies (6)
- ocaml_intrinsics
>= "v0.16.1" - tracing
- cmdliner
>= "1.1.0" - hdr_histogram
- ocaml
>= "5.0.0~" - dune
>= "3.2"
Used by (1)
Conflicts
None