doc(profile): improve profiling docs

ipfs · Jul 22, 2021 · 3745047 · 3745047
1 parent 0bea7ce
commit 3745047
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/core/commands/profile.go b/core/commands/profile.go
@@ -38,6 +38,9 @@ Collects cpu, heap, and goroutine profiles from a running go-ipfs daemon
 into a single zipfile. To aid in debugging, this command also attempts to
 include a copy of the running go-ipfs binary.
 
+Profile's can be examined using 'go tool pprof', some tips can be found at
+https://github.com/ipfs/go-ipfs/blob/master/docs/debug-guide.md.
+
 Privacy Notice:
 
 The output file includes:

diff --git a/docs/debug-guide.md b/docs/debug-guide.md
@@ -79,6 +79,9 @@ that goroutine in the middle of a short wait for something. If the wait time is
 over a few minutes, that either means that goroutine doesn't do much, or
 something is pretty wrong.
 
+If you're seeing a lot of goroutines, conside rusing
+[stackparse](https://github.com/whyrusleeping/stackparse) to filter, sort, and summarize them.
+
 ### Analyzing the CPU Profile
 
 The go team wrote an [excellent article on profiling go