3 virt-top - 'top'-like utility for virtualization stats
11 virt-top is a L<top(1)>-like utility for showing stats of virtualized
12 domains. Many keys and command line options are the same as for
15 It uses libvirt so it is capable of showing stats across a variety of
16 different virtualization systems.
24 Display physical CPUs by default (instead of domains).
25 When virt-top is running, use the I<1> key to toggle
26 between physical CPUs and domains display.
30 Display network interfaces by default (instead of domains).
31 When virt-top is running, use the I<2> key to toggle
32 between network interfaces and domains display.
36 Display block devices (virtual disks) by default (instead of domains).
37 When virt-top is running, use the I<3> key to toggle
38 between block devices and domains display.
42 Batch mode. In this mode keypresses are ignored.
44 =item B<-c uri> or B<--connect uri>
46 Connect to URI given. The default is to connect to the Xen
51 Set the delay between screen updates in seconds.
52 The default is 3.0 seconds. You can change this
53 while virt-top is running by pressing either I<s> or I<d> key.
55 =item B<-n iterations>
57 Set the number of iterations to run. The default
58 is to run continuously.
62 Set the sort order to one of:
63 B<cpu> (sort by %CPU used),
64 B<mem> (sort by memory used),
65 B<time> (sort by total time),
66 B<id> (sort by domain ID),
67 B<name> (sort by domain name),
68 B<netrx> (sort by network received bytes),
69 B<nettx> (sort by network transmitted bytes),
70 B<blockrdrq> (sort by block device [disk] read requests),
71 B<blockwrrq> (sort by block device [disk] write requests).
73 While virt-top is running you can change the sort
74 order using keys I<P> (cpu), I<M> (memory),
75 I<T> (total time), I<N> (domain ID),
76 I<F> (interactively select the sort field).
80 Secure mode. Currently this does nothing.
82 =item B<--hist-cpu secs>
84 Set the time in seconds between updates of the historical
85 %CPU at the top right of the display.
87 =item B<--csv file.csv>
89 Write the statistics to file I<file.csv>. First a header is written
90 showing the statistics being recorded in each column, then one line is
91 written for each screen update. The CSV file can be loaded directly
92 by most spreadsheet programs.
94 Currently the statistics which this records vary between releases of
95 virt-top (but the column headers will stay the same, so you can use
96 those to process the CSV file).
98 Not every version of virt-top supports CSV output - it depends how the
99 program was compiled (see I<README> file in the source distribution
102 =item B<--debug filename>
104 Send debug and error messages to I<filename>.
105 To send error messages to syslog you can do:
107 virt-top --debug >(logger -t virt-top)
109 See also REPORTING BUGS below.
111 =item B<--init-file filename>
113 Read I<filename> as the init file instead of the default which is
114 I<$HOME/.virt-toprc>. See also INIT FILE below.
116 =item B<--no-init-file>
118 Do not read any init file.
122 Script mode. There will be no user interface. This is most useful
123 when used together with the I<--csv> and I<-n> options.
127 Display usage summary.
133 Note that keys are case sensitive. For example use upper-case I<P>
134 (shift P) to sort by %CPU. I<^> before a key means a Ctrl key, so
139 =item I<space> or I<^L>
153 Change the delay between screen updates.
155 =item I<0> (number 0)
157 Show the normal list of domains display.
159 =item I<1> (number 1)
161 Toggle into showing physical CPUs. If pressed
162 again toggles back to showing domains (the normal
167 Toggle into showing network interfaces. If pressed
168 again toggles back to showing domains.
172 Toggle into showing block devices (virtual disks). If pressed again
173 toggles back to showing domains.
193 Select the sort field interactively (there are other
194 sort fields you can choose using this key).
198 This creates or overwrites the init file with the current settings.
200 This key is disabled if I<--no-init-file> was specified on the
201 command line or if I<overwrite-init-file false> is given in
208 When virt-top starts up, it reads initial settings from the
209 file I<.virt-toprc> in the user's home directory.
211 The name of this file may be overridden using the I<--init-file
212 filename> command line option or may be disabled entirely using
215 The init file has a simple format. Blank lines and comments
216 beginning with I<#> are ignored. Everything else is a set of
217 I<key value> pairs, described below.
221 =item B<display> I<task|pcpu|block|net>
223 Sets the major display mode to one of I<task> (tasks, the
224 default), I<pcpu> (physical CPUs), I<block> (block devices),
225 or I<net> (network interfaces).
227 =item B<delay> I<secs>
229 Sets the delay between display updates in seconds.
231 =item B<hist-cpu> I<secs>
233 Sets the historical CPU delay in seconds.
235 =item B<iterations> I<n>
237 Sets the number of iterations to run before we exit. Setting
238 this to I<-1> means to run continuously.
240 =item B<sort> I<cpu|mem|time|id|name|...>
242 Sets the sort order. The option names are the same as for
243 the command line I<-o> option.
245 =item B<connect> I<uri>
247 Sets the default connection URI.
249 =item B<debug> I<filename>
251 Sets the default filename to use for debug and error messages.
253 =item B<csv> I<filename>
255 Enables CSV output to the named file.
257 =item B<batch> I<true|false>
261 =item B<secure> I<true|false>
265 =item B<script> I<true|false>
269 =item B<overwrite-init-file> I<false>
271 If set to I<false> then the I<W> key will not overwrite the
277 Note that in the current implementation, options specified in
278 the init file override options specified on the command line.
279 This is a bug and this behaviour may change in the future.
287 L<http://www.libvirt.org/>,
288 L<http://et.redhat.com/~rjones/>,
289 L<http://caml.inria.fr/>
293 Richard W.M. Jones <rjones @ redhat . com>
295 =head1 REPORTING BUGS
297 Bugs can be viewed on the Red Hat Bugzilla page:
298 L<https://bugzilla.redhat.com/>.
300 If you find a bug in virt-top, please follow these steps to report it:
304 =item 1. Check for existing bug reports
306 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
307 Someone may already have reported the same bug, and they may even
310 =item 2. Capture debug and error messages
314 virt-top --debug virt-top.log
316 and keep I<virt-top.log>. It contains error messages which you
317 should submit with your bug report.
319 =item 3. Get version of virt-top and version of libvirt.
321 In virt-top, press the I<h> (help) key, and write down the version of
322 virt-top and the version of libvirt. They are shown in the first
325 =item 4. Submit a bug report.
327 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
328 Please describe the problem in as much detail as possible.
330 Remember to include the version numbers (step 3) and the debug
331 messages file (step 2).
333 =item 5. Assign the bug to rjones @ redhat.com
335 Assign or reassign the bug to B<rjones @ redhat.com> (without the
336 spaces). You can also send me an email with the bug number if you
337 want a faster response.