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 Disable domain CPU stats in CSV output.
79 Disable domain block device stats in CSV output.
82 Disable domain network interface stats in CSV output.
85 Send debug and error messages to *filename*. To send error messages
88 virt-top --debug >(logger -t virt-top)
90 See also REPORTING BUGS below.
93 Read *filename* as the init file instead of the default which is
94 *$HOME/.virt-toprc*. See also INIT FILE below.
97 Do not read any init file.
100 Script mode. There will be no user interface. This is most useful
101 when used together with the *--csv* and *-n* options.
104 Display usage summary.
107 Note that keys are case sensitive. For example use upper-case *P* (shift
108 P) to sort by %CPU. *^* before a key means a Ctrl key, so *^L* is Ctrl
114 *q* Quits the program.
119 Change the delay between screen updates.
122 Show the normal list of domains display.
125 Toggle into showing physical CPUs. If pressed again toggles back to
126 showing domains (the normal display).
128 *2* Toggle into showing network interfaces. If pressed again toggles
129 back to showing domains.
131 *3* Toggle into showing block devices (virtual disks). If pressed again
132 toggles back to showing domains.
138 *T* Sort by total time.
140 *N* Sort by domain ID.
142 *F* Select the sort field interactively (there are other sort fields you
143 can choose using this key).
145 *W* This creates or overwrites the init file with the current settings.
147 This key is disabled if *--no-init-file* was specified on the
148 command line or if *overwrite-init-file false* is given in the init
152 When virt-top starts up, it reads initial settings from the file
153 *.virt-toprc* in the user's home directory.
155 The name of this file may be overridden using the *--init-file filename*
156 command line option or may be disabled entirely using *--no-init-file*.
158 The init file has a simple format. Blank lines and comments beginning
159 with *#* are ignored. Everything else is a set of *key value* pairs,
162 display *task|pcpu|block|net*
163 Sets the major display mode to one of *task* (tasks, the default),
164 *pcpu* (physical CPUs), *block* (block devices), or *net* (network
168 Sets the delay between display updates in seconds.
171 Sets the historical CPU delay in seconds.
174 Sets the number of iterations to run before we exit. Setting this to
175 *-1* means to run continuously.
177 sort *cpu|mem|time|id|name|...*
178 Sets the sort order. The option names are the same as for the
179 command line *-o* option.
182 Sets the default connection URI.
185 Sets the default filename to use for debug and error messages.
188 Enables CSV output to the named file.
191 Enable or disable domain CPU stats in CSV output.
193 csv-block *true|false*
194 Enable or disable domain block device stats in CSV output.
197 Enable or disable domain network interface stats in CSV output.
208 overwrite-init-file *false*
209 If set to *false* then the *W* key will not overwrite the init file.
211 Note that in the current implementation, options specified in the init
212 file override options specified on the command line. This is a bug and
213 this behaviour may change in the future.
216 top(1), virsh(1), xm(1), xentop(1), <http://www.libvirt.org/>,
217 <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>
220 Richard W.M. Jones <rjones @ redhat . com>
223 (C) Copyright 2007 Red Hat Inc., Richard W.M. Jones http://libvirt.org/
225 This program is free software; you can redistribute it and/or modify it
226 under the terms of the GNU General Public License as published by the
227 Free Software Foundation; either version 2 of the License, or (at your
228 option) any later version.
230 This program is distributed in the hope that it will be useful, but
231 WITHOUT ANY WARRANTY; without even the implied warranty of
232 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
233 Public License for more details.
235 You should have received a copy of the GNU General Public License along
236 with this program; if not, write to the Free Software Foundation, Inc.,
237 675 Mass Ave, Cambridge, MA 02139, USA.
240 Bugs can be viewed on the Red Hat Bugzilla page:
241 <https://bugzilla.redhat.com/>.
243 If you find a bug in virt-top, please follow these steps to report it:
245 1. Check for existing bug reports
246 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
247 Someone may already have reported the same bug, and they may even
250 2. Capture debug and error messages
253 virt-top --debug virt-top.log
255 and keep *virt-top.log*. It contains error messages which you should
256 submit with your bug report.
258 3. Get version of virt-top and version of libvirt.
259 In virt-top, press the *h* (help) key, and write down the version of
260 virt-top and the version of libvirt. They are shown in the first
263 4. Submit a bug report.
264 Go to <https://bugzilla.redhat.com/> and enter a new bug. Please
265 describe the problem in as much detail as possible.
267 Remember to include the version numbers (step 3) and the debug
268 messages file (step 2).
270 5. Assign the bug to rjones @ redhat.com
271 Assign or reassign the bug to rjones @ redhat.com (without the
272 spaces). You can also send me an email with the bug number if you
273 want a faster response.