README
1Contents
2========
3
4- Overview
5- Installation
6- Usage
7
8
9Overview
10========
11
12This application provides SPDK live statistics regarding usage of cores,
13threads, pollers, execution times, and relations between those. All data
14is being gathered from SPDK by calling appropriate RPC calls. Application
15consists of three selectable tabs providing statistics related to three
16main topics:
17
18- Threads
19- Pollers
20- Cores
21
22
23Installation
24============
25
26spdk_top requires Ncurses library (can by installed by running
27spdk/scripts/pkgdep.sh) and is compiled by default when SPDK compiles.
28
29
30
31Usage
32=====
33
34To run spdk_top:
35
36sudo spdk_top [options]
37
38options:
39 -r <path> RPC listen address (optional, default: /var/tmp/spdk.sock)
40 -h show help message
41
42Application consists of:
43- Tabs list (on top)
44- Statistics window (main windows in the middle)
45- Options window (below statistics window)
46- Page indicator / Error status
47
48Tabs list shows available tabs and highlights currently selected tab.
49Statistics window displays current statistics. Available statistics
50depend on which tab is currently selected. All time and run counter
51related statistics are relative - show elapsed time / number of runs
52since previous data refresh. Options windows provide hotkeys list
53to change application settings. Available options are:
54
55- [q] Quit - quit the application
56- [1-3] TAB selection - select tab to be displayed
57- [PgUp] Previous page - go to previous page
58- [PgDown] Next page - go to next page
59- [c] Columns - select which columns should be visible / hidden:
60 Use arrow up / down and space / enter keys to select which columns
61 should be visible. Select 'CLOSE' to confirm changes and close
62 the window.
63- [s] Sorting - change data sorting:
64 Use arrow up / down to select based on which column data should be
65 sorted. Use enter key to confirm or esc key to exit without
66 changing current sorting scheme.
67- [r] Refresh rate - change data refresh rate:
68 Enter new data refresh rate value. Refresh rate accepts value
69 between 0 and 255 seconds. Use enter key to apply or escape key
70 to cancel.
71
72Page indicator show current data page. Error status can be displayed
73on bottom right side of the screen when the application encountered
74an error.
75