2 virt-top - 'top'-like utility for virtualization stats
8 virt-top is a top(1)-like utility for showing stats of virtualized
9 domains. Many keys and command line options are the same as for ordinary
12 It uses libvirt so it is capable of showing stats across a variety of
13 different virtualization systems.
16 -1 Display physical CPUs by default (instead of domains). When virt-top
17 is running, use the *1* key to toggle between physical CPUs and
20 -2 Display network interfaces by default (instead of domains). When
21 virt-top is running, use the *2* key to toggle between network
22 interfaces and domains display.
24 -3 Display block devices (virtual disks) by default (instead of
25 domains). When virt-top is running, use the *3* key to toggle
26 between block devices and domains display.
28 -b Batch mode. In this mode keypresses are ignored.
30 -c uri or --connect uri
31 Connect to URI given. The default is to connect to the Xen
35 Set the delay between screen updates in seconds. The default is 3.0
36 seconds. You can change this while virt-top is running by pressing
37 either *s* or *d* key.
40 Set the number of iterations to run. The default is to run
44 Set the sort order to one of: cpu (sort by %CPU used), mem (sort by
45 memory used), time (sort by total time), id (sort by domain ID),
46 name (sort by domain name), netrx (sort by network received bytes),
47 nettx (sort by network transmitted bytes), blockrdrq (sort by block
48 device [disk] read requests), blockwrrq (sort by block device [disk]
51 While virt-top is running you can change the sort order using keys
52 *P* (cpu), *M* (memory), *T* (total time), *N* (domain ID), *F*
53 (interactively select the sort field).
55 -s Secure mode. Currently this does nothing.
58 Set the time in seconds between updates of the historical %CPU at
59 the top right of the display.
62 Write the statistics to file *file.csv*. First a header is written
63 showing the statistics being recorded in each column, then one line
64 is written for each screen update. The CSV file can be loaded
65 directly by most spreadsheet programs.
67 Currently the statistics which this records vary between releases of
68 virt-top (but the column headers will stay the same, so you can use
69 those to process the CSV file).
71 Not every version of virt-top supports CSV output - it depends how
72 the program was compiled (see *README* file in the source
73 distribution for details).
76 Send debug and error messages to *filename*. To send error messages
79 virt-top --debug >(logger -t virt-top)
81 See also REPORTING BUGS below.
84 Display usage summary.
87 Note that keys are case sensitive. For example use upper-case *P* (shift
88 P) to sort by %CPU. *^* before a key means a Ctrl key, so *^L* is Ctrl
94 *q* Quits the program.
99 Change the delay between screen updates.
102 Show the normal list of domains display.
105 Toggle into showing physical CPUs. If pressed again toggles back to
106 showing domains (the normal display).
108 *2* Toggle into showing network interfaces. If pressed again toggles
109 back to showing domains.
111 *3* Toggle into showing block devices (virtual disks). If pressed again
112 toggles back to showing domains.
118 *T* Sort by total time.
120 *N* Sort by domain ID.
122 *F* Select the sort field interactively (there are other sort fields you
123 can choose using this key).
126 top(1), virsh(1), xm(1), xentop(1), <http://www.libvirt.org/>,
127 <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>
130 Richard W.M. Jones <rjones @ redhat . com>
133 Bugs can be viewed on the Red Hat Bugzilla page:
134 <https://bugzilla.redhat.com/>.
136 If you find a bug in virt-top, please follow these steps to report it:
138 1. Check for existing bug reports
139 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
140 Someone may already have reported the same bug, and they may even
143 2. Capture debug and error messages
146 virt-top --debug virt-top.log
148 and keep *virt-top.log*. It contains error messages which you should
149 submit with your bug report.
151 3. Get version of virt-top and version of libvirt.
152 In virt-top, press the *h* (help) key, and write down the version of
153 virt-top and the version of libvirt. They are shown in the first
156 4. Submit a bug report.
157 Go to <https://bugzilla.redhat.com/> and enter a new bug. Please
158 describe the problem in as much detail as possible.
160 Remember to include the version numbers (step 3) and the debug
161 messages file (step 2).
163 5. Assign the bug to rjones @ redhat.com
164 Assign or reassign the bug to rjones @ redhat.com (without the
165 spaces). You can also send me an email with the bug number if you
166 want a faster response.