numam-spdk

History

Jim Harris e0ca35c4f6 spdk_top: allow connecting with TCP port JSON-RPC server (spdk_rpc_listen) only listens on a UNIX domain socket. If users wish to issue JSON-RPC calls over a TCP socket for debugging purposes, they can forward calls using socat, i.e. socat TCP4-LISTEN:8989,reuseaddr,fork,bind=127.0.0.1 \ UNIX-CLIENT:/var/tmp/spdk.sock This could allow running spdk_top to debug or monitor an SPDK application remotely. But currently spdk_top -r option assumes AF_UNIX. Look at the first character in the -r option (if provided) - if it's '/' use AF_UNIX, otherwise AF_INET. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ie9c33bb0fb66dff895359f6f6608862df42b542c Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/11567 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Mellanox Build Bot Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>		2022-02-15 16:46:17 +00:00
..
.gitignore	app: Initial patch for spdk_top application	2020-04-22 09:17:14 +00:00
Makefile	ARM64: Cross-Compilation Support	2021-07-13 08:58:42 +00:00
README	spdk_top: Add README file	2020-04-22 19:03:18 +00:00
spdk_top.c	spdk_top: allow connecting with TCP port	2022-02-15 16:46:17 +00:00

README

Contents
========

- Overview
- Installation
- Usage


Overview
========

This application provides SPDK live statistics regarding usage of cores,
threads, pollers, execution times, and relations between those. All data
is being gathered from SPDK by calling appropriate RPC calls. Application
consists of three selectable tabs providing statistics related to three
main topics:

- Threads
- Pollers
- Cores


Installation
============

spdk_top requires Ncurses library (can by installed by running
spdk/scripts/pkgdep.sh) and is compiled by default when SPDK compiles.



Usage
=====

To run spdk_top:

sudo spdk_top [options]

options:
 -r <path>  RPC listen address (optional, default: /var/tmp/spdk.sock)
 -h         show help message

Application consists of:
- Tabs list (on top)
- Statistics window (main windows in the middle)
- Options window (below statistics window)
- Page indicator / Error status

Tabs list shows available tabs and highlights currently selected tab.
Statistics window displays current statistics. Available statistics
depend on which tab is currently selected. All time and run counter
related statistics are relative - show elapsed time / number of runs
since previous data refresh. Options windows provide hotkeys list
to change application settings. Available options are:

- [q] Quit - quit the application
- [1-3] TAB selection - select tab to be displayed
- [PgUp] Previous page - go to previous page
- [PgDown] Next page - go to next page
- [c] Columns - select which columns should be visible / hidden:
  Use arrow up / down and space / enter keys to select which columns
  should be visible. Select 'CLOSE' to confirm changes and close
  the window.
- [s] Sorting - change data sorting:
  Use arrow up / down to select based on which column data should be
  sorted. Use enter key to confirm or esc key to exit without
  changing current sorting scheme.
- [r]  Refresh rate - change data refresh rate:
  Enter new data refresh rate value. Refresh rate accepts value
  between 0 and 255 seconds. Use enter key to apply or escape key
  to cancel.

Page indicator show current data page. Error status can be displayed
on bottom right side of the screen when the application encountered
an error.