docs: Add notes on using pprof for development (#11690)

Signed-off-by: Yuan (Terry) Tang <[email protected]>
argoproj · Aug 29, 2023 · f00b6ff · f00b6ff
1 parent 18820c3
commit f00b6ff
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.spelling b/.spelling
@@ -177,6 +177,7 @@ natively
 OpenAPI
 p.m.
 params
+pprof
 pre-commit
 rc2
 repo

diff --git a/docs/running-locally.md b/docs/running-locally.md
@@ -227,6 +227,14 @@ git commit --signoff -m 'feat: Added a new feature. Fixes #1234'
   have checked out your code into `$GOPATH/src/github.com/argoproj/argo-workflows`.
 * If you encounter "out of heap" issues when building UI through Docker, please validate resources allocated to Docker.
   Compilation may fail if allocated RAM is less than 4Gi.
+* To start profiling with [`pprof`](https://go.dev/blog/pprof), pass `ARGO_PPROF=true` when starting the controller locally.
+  Then run the following:
+
+```bash
+go tool pprof http://localhost:6060/debug/pprof/profile   # 30-second CPU profile
+go tool pprof http://localhost:6060/debug/pprof/heap      # heap profile
+go tool pprof http://localhost:6060/debug/pprof/block     # goroutine blocking profile
+```
 
 ## Using Multiple Terminals
-Original file line number
+Diff line change
@@ Expand Up / @@ -177,6 +177,7 @@ natively @@
     OpenAPI
     p.m.
     params
+    pprof
     pre-commit
     rc2
     repo
@@ Expand Down @@