ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

spdk_top.md: add a note about supported apps

Browse Source 
Currently our docs do not specify apps that can be
viewed by spdk_top tool.

Change-Id: I32ce0e54e114a8a6a4ea135f61d7907062872398
Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15604
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
Krzysztof Karas 2022-11-23 16:24:14 +01:00 committed by Tomasz Zawadzki
parent c271381112
commit 6cc23f29d7
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/spdk_top.md
View File

@ -15,6 +15,10 @@ spdk_top utility gets the fine grained metrics from the pollers, analyzes and re
This information enables users to identify CPU cores that are busy doing real work so that they can determine if the application
needs more or less CPU resources.
spdk_top uses RPCs to communicate with the app it is viewing, so it will work only with those that run RPC server and support
`thread_get_stats`, `thread_get_pollers`, `framework_get_reactors` methods. Apps currently meeting this criteria:
spdk_tgt, nvmf_tgt, vhost, iscsi_tgt.
## Run spdk_top
Before running spdk_top you need to run the SPDK application whose performance you want to analyze using spdk_top.