doc: profiling remote compute nodes (#7426)

Approved-By: BugenZhao Co-Authored-By: Yuhao Su <yuhaosu@outlook.com> Co-Authored-By: Bugen Zhao <i@bugenzhao.com> Co-Authored-By: Yuhao Su <31772373+yuhao-su@users.noreply.github.com>
risingwavelabs · Jan 18, 2023 · f0918d7 · f0918d7
1 parent 55d82fd
commit f0918d7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/cpu-profiling.md b/docs/cpu-profiling.md
@@ -1,5 +1,6 @@
 # CPU Profiling Guide
 
+## Profiling on host
 Share an easy-to-use profiler and flamegraph tool: https://github.com/koute/not-perf.git
 
 Record samples:
@@ -13,3 +14,12 @@ Generate flamegraph:
 ```shell
 nperf flamegraph perf.data > perf.svg
 ```
+
+## Profiling remote compute nodes
+You can profile remote compute nodes from a local machine by simply type the following command.
+```shell
+./risedev ctl profile --sleep [seconds]
+```
+All compute nodes will be profile for a given `seconds` time and generated flame graph will be transferred to your local machine `.risingwave/profiling/`.
+
+Note: To profile compute nodes remotely, please make sure all remote nodes have a public IP address accessible from your local machine (where you are running `risedev`).
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
@@ -232,7 +232,7 @@ cargo run --bin risectl -- --help
 ... or
 
 ```
-./risingwave risectl --help
+./risedev ctl --help
 ```
 
 for more information.
-Original file line number
+Diff line change
@@ Expand Up / @@ -232,7 +232,7 @@ cargo run --bin risectl -- --help @@
     ... or
     ```
-    ./risingwave risectl --help
+    ./risedev ctl --help
     ```
     for more information.
@@ Expand Down @@