debug: document the debug script
fixes #6457
Steven Allen committed
Jul 8, 2019 at 05:34 UTC
20f7ce8508274c73f81ead5e15f475675a3137e8
1 file changed
+5
-4
docs/debug-guide.md
+5
-4
@@ -15,6 +15,11 @@ When you see ipfs doing something (using lots of CPU, memory, or otherwise
15
being weird), the first thing you want to do is gather all the relevant
16
profiling information.
17
18
+There's a script (`bin/collect-profiles.sh`) that will do this for you and
19
+bundle the results up into a tarball, ready to be attached to a bug report.
20
+
21
+If you feel intrepid, you can dump this information and investigate it yourself:
22
+
23
- goroutine dump
24
- `curl localhost:5001/debug/pprof/goroutine\?debug=2 > ipfs.stacks`
25
- 30 second cpu profile
@@ -26,10 +31,6 @@ profiling information.
31
- system information
32
- `ipfs diag sys > ipfs.sysinfo`
33
29
-Bundle all that up and include a copy of the ipfs binary that you are running
30
-(having the exact same binary is important, it contains debug info).
31
-
32
-You can investigate yourself if you feel intrepid:
34
35
### Analyzing the stack dump
36