virt-top/virt-top.pod

   1 =head1 NAME
   2
   3 virt-top - 'top'-like utility for virtualization stats
   4
   5 =head1 SUMMARY
   6
   7 virt-top [-options]
   8
   9 =head1 DESCRIPTION
  10
  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
  13 ordinary I<top>.
  14
  15 It uses libvirt so it is capable of showing stats across a variety of
  16 different virtualization systems.
  17
  18 =head1 OPTIONS
  19
  20 =over 4
  21
  22 =item B<-1>
  23
  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.
  27
  28 =item B<-2>
  29
  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.
  33
  34 =item B<-3>
  35
  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.
  39
  40 =item B<-b>
  41
  42 Batch mode.  In this mode keypresses are ignored.
  43
  44 =item B<-c uri> or B<--connect uri>
  45
  46 Connect to URI given.  The default is to connect to the Xen
  47 hypervisor.
  48
  49 =item B<-d delay>
  50
  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.
  54
  55 =item B<-n iterations>
  56
  57 Set the number of iterations to run.  The default
  58 is to run continuously.
  59
  60 =item B<-o sort>
  61
  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).
  72
  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).
  77
  78 =item B<-s>
  79
  80 Secure mode.  Currently this does nothing.
  81
  82 =item B<--hist-cpu secs>
  83
  84 Set the time in seconds between updates of the historical
  85 %CPU at the top right of the display.
  86
  87 =item B<--csv file.csv>
  88
  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.
  93
  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).
  97
  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
 100 for details).
 101
 102 =item B<--debug filename>
 103
 104 Send debug and error messages to I<filename>.
 105 To send error messages to syslog you can do:
 106
 107  virt-top --debug >(logger -t virt-top)
 108
 109 See also REPORTING BUGS below.
 110
 111 =item B<--init-file filename>
 112
 113 Read I<filename> as the init file instead of the default which is
 114 I<$HOME/.virt-toprc>.  See also INIT FILE below.
 115
 116 =item B<--no-init-file>
 117
 118 Do not read any init file.
 119
 120 =item B<--script>
 121
 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.
 124
 125 =item B<--help>
 126
 127 Display usage summary.
 128
 129 =back
 130
 131 =head1 KEYS
 132
 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
 135 I<^L> is Ctrl L.
 136
 137 =over 4
 138
 139 =item I<space> or I<^L>
 140
 141 Updates the display.
 142
 143 =item I<q>
 144
 145 Quits the program.
 146
 147 =item I<h>
 148
 149 Displays help.
 150
 151 =item I<s> or I<d>
 152
 153 Change the delay between screen updates.
 154
 155 =item I<0> (number 0)
 156
 157 Show the normal list of domains display.
 158
 159 =item I<1> (number 1)
 160
 161 Toggle into showing physical CPUs.  If pressed
 162 again toggles back to showing domains (the normal
 163 display).
 164
 165 =item I<2>
 166
 167 Toggle into showing network interfaces.  If pressed
 168 again toggles back to showing domains.
 169
 170 =item I<3>
 171
 172 Toggle into showing block devices (virtual disks).  If pressed again
 173 toggles back to showing domains.
 174
 175 =item I<P>
 176
 177 Sort by %CPU.
 178
 179 =item I<M>
 180
 181 Sort by memory.
 182
 183 =item I<T>
 184
 185 Sort by total time.
 186
 187 =item I<N>
 188
 189 Sort by domain ID.
 190
 191 =item I<F>
 192
 193 Select the sort field interactively (there are other
 194 sort fields you can choose using this key).
 195
 196 =item I<W>
 197
 198 This creates or overwrites the init file with the current settings.
 199
 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
 202 the init file.
 203
 204 =back
 205
 206 =head1 INIT FILE
 207
 208 When virt-top starts up, it reads initial settings from the
 209 file I<.virt-toprc> in the user's home directory.
 210
 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
 213 I<--no-init-file>.
 214
 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.
 218
 219 =over 4
 220
 221 =item B<display> I<task|pcpu|block|net>
 222
 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).
 226
 227 =item B<delay> I<secs>
 228
 229 Sets the delay between display updates in seconds.
 230
 231 =item B<hist-cpu> I<secs>
 232
 233 Sets the historical CPU delay in seconds.
 234
 235 =item B<iterations> I<n>
 236
 237 Sets the number of iterations to run before we exit.  Setting
 238 this to I<-1> means to run continuously.
 239
 240 =item B<sort> I<cpu|mem|time|id|name|...>
 241
 242 Sets the sort order.  The option names are the same as for
 243 the command line I<-o> option.
 244
 245 =item B<connect> I<uri>
 246
 247 Sets the default connection URI.
 248
 249 =item B<debug> I<filename>
 250
 251 Sets the default filename to use for debug and error messages.
 252
 253 =item B<csv> I<filename>
 254
 255 Enables CSV output to the named file.
 256
 257 =item B<batch> I<true|false>
 258
 259 Sets batch mode.
 260
 261 =item B<secure> I<true|false>
 262
 263 Sets secure mode.
 264
 265 =item B<script> I<true|false>
 266
 267 Sets script mode.
 268
 269 =item B<overwrite-init-file> I<false>
 270
 271 If set to I<false> then the I<W> key will not overwrite the
 272 init file.
 273
 274 =back
 275
 276
 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.
 280
 281 =head1 SEE ALSO
 282
 283 L<top(1)>,
 284 L<virsh(1)>,
 285 L<xm(1)>,
 286 L<xentop(1)>,
 287 L<http://www.libvirt.org/>,
 288 L<http://et.redhat.com/~rjones/>,
 289 L<http://caml.inria.fr/>
 290
 291 =head1 AUTHORS
 292
 293 Richard W.M. Jones <rjones @ redhat . com>
 294
 295 =head1 REPORTING BUGS
 296
 297 Bugs can be viewed on the Red Hat Bugzilla page:
 298 L<https://bugzilla.redhat.com/>.
 299
 300 If you find a bug in virt-top, please follow these steps to report it:
 301
 302 =over 4
 303
 304 =item 1. Check for existing bug reports
 305
 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
 308 have fixed it.
 309
 310 =item 2. Capture debug and error messages
 311
 312 Run
 313
 314  virt-top --debug virt-top.log
 315
 316 and keep I<virt-top.log>.  It contains error messages which you
 317 should submit with your bug report.
 318
 319 =item 3. Get version of virt-top and version of libvirt.
 320
 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
 323 line.
 324
 325 =item 4. Submit a bug report.
 326
 327 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 328 Please describe the problem in as much detail as possible.
 329
 330 Remember to include the version numbers (step 3) and the debug
 331 messages file (step 2).
 332
 333 =item 5. Assign the bug to rjones @ redhat.com
 334
 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.
 338
 339 =back
 340
 341 =end