doc(profile): improve profiling docs
Steven Allen committed
Jul 21, 2021 at 18:02 UTC
3745047ccf59bf81a7297c2d7400edb586063f47
2 files changed
+6
core/commands/profile.go
+3
@@ -38,6 +38,9 @@ Collects cpu, heap, and goroutine profiles from a running go-ipfs daemon
38
into a single zipfile. To aid in debugging, this command also attempts to
39
include a copy of the running go-ipfs binary.
40
41
+Profile's can be examined using 'go tool pprof', some tips can be found at
42
+https://github.com/ipfs/go-ipfs/blob/master/docs/debug-guide.md.
43
+
44
Privacy Notice:
45
46
The output file includes:
docs/debug-guide.md
+3
@@ -79,6 +79,9 @@ that goroutine in the middle of a short wait for something. If the wait time is
79
over a few minutes, that either means that goroutine doesn't do much, or
80
something is pretty wrong.
81
82
+If you're seeing a lot of goroutines, conside rusing
83
+[stackparse](https://github.com/whyrusleeping/stackparse) to filter, sort, and summarize them.
84
+
85
### Analyzing the CPU Profile
86
87
The go team wrote an [excellent article on profiling go