TheArchive/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-12-11 18:47:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: when describing profiling, briefly explain .pprof files

Browse Source
This commit is contained in:
Ilya Grigoriev
2025-04-27 20:20:05 -07:00
committed by Michael Eischer
parent 67a572fa0d
commit 16850c61fa
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/090_participating.rst
View File

@@ -71,10 +71,17 @@ The program can be built with debug support like this:
$ go run build.go -tags debug $ go run build.go -tags debug
This will make the ``restic debug <subcommand>`` available which can be used to This will make the ``restic debug <subcommand>`` available which can be used to
inspect internal data structures. In addition, this enables profiling flags such inspect internal data structures.
as ``--cpu-profile`` and ``--mem-profile`` which can help with investigation
performance and memory usage issues. See ``restic help`` for more details and a In addition, this enables profiling flags such as ``--cpu-profile`` and
few additional ``--...-profile`` flags. ``--mem-profile`` which can help with investigation performance and memory usage
issues. See ``restic help`` for more details and a few additional
``--...-profile`` flags.
Running Restic with profiling enabled generates a ``.pprof`` file such as
``cpu.pprof``. To view a profile in a web browser, first make sure that the
``dot`` command from `Graphviz <https://graphviz.org/>`__ is in the PATH. Then,
run ``go tool pprof -http : cpu.pprof``.
************ ************