Profiling the Octez node¶
Memory profiling the OCaml heap¶
Install an OCaml switch with the
statmemprofinto the node.
statmemprof-emacspackage as a dependency to the main package, and add
let () = Statmemprof_emacs.start 1E-4 30 5to the
sampling_rateis the sampling rate of the profiler. Good value:
callstack_sizeis the size of the fragment of the call stack which is captured for each sampled allocation.
min_sample_printis the minimum number of samples under which the location of an allocation is not displayed.
Load sturgeon into emacs, by adding this to your
(let ((opam-share (ignore-errors (car (process-lines "opam" "config" "var" "share"))))) (when (and opam-share (file-directory-p opam-share)) (add-to-list 'load-path (expand-file-name "emacs/site-lisp" opam-share)))) (require 'sturgeon)
Launch the node then connect to it with sturgeon.
If the process is launched with pid
M-x sturgeon-connect octez-nodememprof.1234.sturgeon (tab-completion works for finding the socket name)
Memory profiling the C heap¶
valgrind --tool=massif octez-node run ...
Ctrl-Cthen display with
linux-perfpackage for debian).
If the package does not exist for your current kernel, a previous version can be used. Substitute the
perf_4.9if your kernel is 4.9).
Run the node, find the pid.
perf record -p pid -F 99 --call-stack dwarf.
Then stop capturing with
Ctrl-C. This can represent a lot of data. Don’t do that for too long. If this is too much you can remove the
--call-stack dwarfto get something more manageable, but interpreting the information can be harder.
perf record -g -F 99 --call-graph=dwarf -- ./octez-node run ...
This will write
perf.dataafter having stopped the node with
In both cases, the
-Fargument specifies the frequency of sampling of data (in hertz). If too much data is generated, use a smaller value. If data is not precise enough, try using a higher value.
display the result with
perf report, or use a more advanced visualizer (recommended). Such visualizers include:
flamegraph: command-line tool for generating flamegraphs (example for octez-node)
gprof2dot: command-line tool for generating callgraphs (example for octez-node)
hotspot: a GUI for the