virt-top/virt-top.txt

   1 NAME
   2     virt-top - 'top'-like utility for virtualization stats
   3
   4 SUMMARY
   5     virt-top [-options]
   6
   7 DESCRIPTION
   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
  10     *top*.
  11
  12     It uses libvirt so it is capable of showing stats across a variety of
  13     different virtualization systems.
  14
  15 OPTIONS
  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
  18         domains display.
  19
  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.
  23
  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.
  27
  28     -b  Batch mode. In this mode keypresses are ignored.
  29
  30     -c uri or --connect uri
  31         Connect to URI given. The default is to connect to the Xen
  32         hypervisor.
  33
  34     -d delay
  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.
  38
  39     -n iterations
  40         Set the number of iterations to run. The default is to run
  41         continuously.
  42
  43     -o sort
  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]
  49         write requests).
  50
  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).
  54
  55     -s  Secure mode. Currently this does nothing.
  56
  57     --hist-cpu secs
  58         Set the time in seconds between updates of the historical %CPU at
  59         the top right of the display.
  60
  61     --csv file.csv
  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.
  66
  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).
  70
  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).
  74
  75     --debug filename
  76         Send debug and error messages to *filename*. To send error messages
  77         to syslog you can do:
  78
  79          virt-top --debug >(logger -t virt-top)
  80
  81         See also REPORTING BUGS below.
  82
  83     --init-file filename
  84         Read *filename* as the init file instead of the default which is
  85         *$HOME/.virt-toprc*. See also INIT FILE below.
  86
  87     --no-init-file
  88         Do not read any init file.
  89
  90     --help
  91         Display usage summary.
  92
  93 KEYS
  94     Note that keys are case sensitive. For example use upper-case *P* (shift
  95     P) to sort by %CPU. *^* before a key means a Ctrl key, so *^L* is Ctrl
  96     L.
  97
  98     *space* or *^L*
  99         Updates the display.
 100
 101     *q* Quits the program.
 102
 103     *h* Displays help.
 104
 105     *s* or *d*
 106         Change the delay between screen updates.
 107
 108     *0* (number 0)
 109         Show the normal list of domains display.
 110
 111     *1* (number 1)
 112         Toggle into showing physical CPUs. If pressed again toggles back to
 113         showing domains (the normal display).
 114
 115     *2* Toggle into showing network interfaces. If pressed again toggles
 116         back to showing domains.
 117
 118     *3* Toggle into showing block devices (virtual disks). If pressed again
 119         toggles back to showing domains.
 120
 121     *P* Sort by %CPU.
 122
 123     *M* Sort by memory.
 124
 125     *T* Sort by total time.
 126
 127     *N* Sort by domain ID.
 128
 129     *F* Select the sort field interactively (there are other sort fields you
 130         can choose using this key).
 131
 132     *W* This creates or overwrites the init file with the current settings.
 133
 134         This key is disabled if *--no-init-file* was specified on the
 135         command line or if *overwrite-init-file false* is given in the init
 136         file.
 137
 138 INIT FILE
 139     When virt-top starts up, it reads initial settings from the file
 140     *.virt-toprc* in the user's home directory.
 141
 142     The name of this file may be overridden using the *--init-file filename*
 143     command line option or may be disabled entirely using *--no-init-file*.
 144
 145     The init file has a simple format. Blank lines and comments beginning
 146     with *#* are ignored. Everything else is a set of *key value* pairs,
 147     described below.
 148
 149     display *task|pcpu|block|net*
 150         Sets the major display mode to one of *task* (tasks, the default),
 151         *pcpu* (physical CPUs), *block* (block devices), or *net* (network
 152         interfaces).
 153
 154     delay *secs*
 155         Sets the delay between display updates in seconds.
 156
 157     hist-cpu *secs*
 158         Sets the historical CPU delay in seconds.
 159
 160     iterations *n*
 161         Sets the number of iterations to run before we exit. Setting this to
 162         *-1* means to run continuously.
 163
 164     sort *cpu|mem|time|id|name|...*
 165         Sets the sort order. The option names are the same as for the
 166         command line *-o* option.
 167
 168     connect *uri*
 169         Sets the default connection URI.
 170
 171     debug *filename*
 172         Sets the default filename to use for debug and error messages.
 173
 174     csv *filename*
 175         Enables CSV output to the named file.
 176
 177     batch *true|false*
 178         Sets batch mode.
 179
 180     secure *true|false*
 181         Sets secure mode.
 182
 183     overwrite-init-file *false*
 184         If set to *false* then the *W* key will not overwrite the init file.
 185
 186     Note that in the current implementation, options specified in the init
 187     file override options specified on the command line. This is a bug and
 188     this behaviour may change in the future.
 189
 190 SEE ALSO
 191     top(1), virsh(1), xm(1), xentop(1), <http://www.libvirt.org/>,
 192     <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>
 193
 194 AUTHORS
 195     Richard W.M. Jones <rjones @ redhat . com>
 196
 197 REPORTING BUGS
 198     Bugs can be viewed on the Red Hat Bugzilla page:
 199     <https://bugzilla.redhat.com/>.
 200
 201     If you find a bug in virt-top, please follow these steps to report it:
 202
 203     1. Check for existing bug reports
 204         Go to <https://bugzilla.redhat.com/> and search for similar bugs.
 205         Someone may already have reported the same bug, and they may even
 206         have fixed it.
 207
 208     2. Capture debug and error messages
 209         Run
 210
 211          virt-top --debug virt-top.log
 212
 213         and keep *virt-top.log*. It contains error messages which you should
 214         submit with your bug report.
 215
 216     3. Get version of virt-top and version of libvirt.
 217         In virt-top, press the *h* (help) key, and write down the version of
 218         virt-top and the version of libvirt. They are shown in the first
 219         line.
 220
 221     4. Submit a bug report.
 222         Go to <https://bugzilla.redhat.com/> and enter a new bug. Please
 223         describe the problem in as much detail as possible.
 224
 225         Remember to include the version numbers (step 3) and the debug
 226         messages file (step 2).
 227
 228     5. Assign the bug to rjones @ redhat.com
 229         Assign or reassign the bug to rjones @ redhat.com (without the
 230         spaces). You can also send me an email with the bug number if you
 231         want a faster response.
 232