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 To connect to QEMU/KVM you would normally do I<-c qemu:///system>
  50
  51 To connect to libvirtd on a remote machine you would normally do
  52 I<-c xen://host/>
  53
  54 Full details on connection URIs is available at
  55 L<http://libvirt.org/uri.html>
  56
  57 =item B<-d delay>
  58
  59 Set the delay between screen updates in seconds.
  60 The default is 3.0 seconds.  You can change this
  61 while virt-top is running by pressing either I<s> or I<d> key.
  62
  63 =item B<-n iterations>
  64
  65 Set the number of iterations to run.  The default
  66 is to run continuously.
  67
  68 =item B<-o sort>
  69
  70 Set the sort order to one of:
  71 B<cpu> (sort by %CPU used),
  72 B<mem> (sort by total memory),
  73 B<time> (sort by total time),
  74 B<id> (sort by domain ID),
  75 B<name> (sort by domain name),
  76 B<netrx> (sort by network received bytes),
  77 B<nettx> (sort by network transmitted bytes),
  78 B<blockrdrq> (sort by block device [disk] read requests),
  79 B<blockwrrq> (sort by block device [disk] write requests).
  80
  81 While virt-top is running you can change the sort
  82 order using keys I<P> (cpu), I<M> (memory),
  83 I<T> (total time), I<N> (domain ID),
  84 I<F> (interactively select the sort field).
  85
  86 =item B<-s>
  87
  88 Secure mode.  Currently this does nothing.
  89
  90 =item B<--hist-cpu secs>
  91
  92 Set the time in seconds between updates of the historical
  93 %CPU at the top right of the display.
  94
  95 =item B<--csv file.csv>
  96
  97 Write the statistics to file I<file.csv>.  First a header is written
  98 showing the statistics being recorded in each column, then one line is
  99 written for each screen update.  The CSV file can be loaded directly
 100 by most spreadsheet programs.
 101
 102 Currently the statistics which this records vary between releases of
 103 virt-top (but the column headers will stay the same, so you can use
 104 those to process the CSV file).
 105
 106 Not every version of virt-top supports CSV output - it depends how the
 107 program was compiled (see I<README> file in the source distribution
 108 for details).
 109
 110 To save space you can compress your CSV files (if your shell supports
 111 this feature, eg. I<bash>):
 112
 113  virt-top --csv >(gzip -9 > output.csv.gz)
 114
 115 You can use a similar trick to split the CSV file up.  In this example
 116 the CSV file is split every 1000 lines into files called
 117 I<output.csv.00>, I<output.csv.01> etc.
 118
 119  virt-top --csv >(split -d -l 1000 - output.csv.)
 120
 121 =item B<--no-csv-cpu>
 122
 123 Disable domain CPU stats in CSV output.
 124
 125 =item B<--no-csv-block>
 126
 127 Disable domain block device stats in CSV output.
 128
 129 =item B<--no-csv-net>
 130
 131 Disable domain network interface stats in CSV output.
 132
 133 =item B<--debug filename>
 134
 135 Send debug and error messages to I<filename>.
 136 To send error messages to syslog you can do:
 137
 138  virt-top --debug >(logger -t virt-top)
 139
 140 See also REPORTING BUGS below.
 141
 142 =item B<--init-file filename>
 143
 144 Read I<filename> as the init file instead of the default which is
 145 I<$HOME/.virt-toprc>.  See also INIT FILE below.
 146
 147 =item B<--no-init-file>
 148
 149 Do not read any init file.
 150
 151 =item B<--script>
 152
 153 Script mode.  There will be no user interface.  This is most useful
 154 when used together with the I<--csv> and I<-n> options.
 155
 156 =item B<--end-time time>
 157
 158 The program will exit at the I<time> given.
 159
 160 The time may be given in one of the following formats:
 161
 162 =over 4
 163
 164 =item I<YYYY-MM-DD HH:MM:SS>
 165
 166 End time is the date and time given.
 167
 168 =item I<HH:MM:SS>
 169
 170 End time is the time given, today.
 171
 172 =item I<+HH:MM:SS>
 173
 174 End time is HH hours, MM minutes, SS seconds in the future (counted
 175 from the moment that program starts).
 176
 177 =item I<+secs>
 178
 179 End time is I<secs> seconds in the future.
 180
 181 =back
 182
 183 For example to run the program for 3 minutes you could do:
 184
 185  virt-top --end-time +00:03:00
 186
 187 or:
 188
 189  virt-top --end-time +180
 190
 191 Not every version of virt-top supports this option - it depends how the
 192 program was compiled (see I<README> file in the source distribution
 193 for details).
 194
 195 =item B<--help>
 196
 197 Display usage summary.
 198
 199 =item B<--version>
 200
 201 Display version number and exit.
 202
 203 =back
 204
 205 =head1 KEYS
 206
 207 Note that keys are case sensitive.  For example use upper-case I<P>
 208 (shift P) to sort by %CPU.  I<^> before a key means a Ctrl key, so
 209 I<^L> is Ctrl L.
 210
 211 =over 4
 212
 213 =item I<space> or I<^L>
 214
 215 Updates the display.
 216
 217 =item I<q>
 218
 219 Quits the program.
 220
 221 =item I<h>
 222
 223 Displays help.
 224
 225 =item I<s> or I<d>
 226
 227 Change the delay between screen updates.
 228
 229 =item I<0> (number 0)
 230
 231 Show the normal list of domains display.
 232
 233 =item I<1> (number 1)
 234
 235 Toggle into showing physical CPUs.  If pressed
 236 again toggles back to showing domains (the normal
 237 display).
 238
 239 =item I<2>
 240
 241 Toggle into showing network interfaces.  If pressed
 242 again toggles back to showing domains.
 243
 244 =item I<3>
 245
 246 Toggle into showing block devices (virtual disks).  If pressed again
 247 toggles back to showing domains.
 248
 249 =item I<P>
 250
 251 Sort by %CPU.
 252
 253 =item I<M>
 254
 255 Sort by total memory.  Note that this shows the total memory
 256 allocated to the guest, not the memory being used.
 257
 258 =item I<T>
 259
 260 Sort by total time.
 261
 262 =item I<N>
 263
 264 Sort by domain ID.
 265
 266 =item I<F>
 267
 268 Select the sort field interactively (there are other
 269 sort fields you can choose using this key).
 270
 271 =item I<W>
 272
 273 This creates or overwrites the init file with the current settings.
 274
 275 This key is disabled if I<--no-init-file> was specified on the
 276 command line or if I<overwrite-init-file false> is given in
 277 the init file.
 278
 279 =back
 280
 281 =head1 INIT FILE
 282
 283 When virt-top starts up, it reads initial settings from the
 284 file I<.virt-toprc> in the user's home directory.
 285
 286 The name of this file may be overridden using the I<--init-file
 287 filename> command line option or may be disabled entirely using
 288 I<--no-init-file>.
 289
 290 The init file has a simple format.  Blank lines and comments
 291 beginning with I<#> are ignored.  Everything else is a set of
 292 I<key value> pairs, described below.
 293
 294 =over 4
 295
 296 =item B<display> I<task|pcpu|block|net>
 297
 298 Sets the major display mode to one of I<task> (tasks, the
 299 default), I<pcpu> (physical CPUs), I<block> (block devices),
 300 or I<net> (network interfaces).
 301
 302 =item B<delay> I<secs>
 303
 304 Sets the delay between display updates in seconds.
 305
 306 =item B<hist-cpu> I<secs>
 307
 308 Sets the historical CPU delay in seconds.
 309
 310 =item B<iterations> I<n>
 311
 312 Sets the number of iterations to run before we exit.  Setting
 313 this to I<-1> means to run continuously.
 314
 315 =item B<sort> I<cpu|mem|time|id|name|...>
 316
 317 Sets the sort order.  The option names are the same as for
 318 the command line I<-o> option.
 319
 320 =item B<connect> I<uri>
 321
 322 Sets the default connection URI.
 323
 324 =item B<debug> I<filename>
 325
 326 Sets the default filename to use for debug and error messages.
 327
 328 =item B<csv> I<filename>
 329
 330 Enables CSV output to the named file.
 331
 332 =item B<csv-cpu> I<true|false>
 333
 334 Enable or disable domain CPU stats in CSV output.
 335
 336 =item B<csv-block> I<true|false>
 337
 338 Enable or disable domain block device stats in CSV output.
 339
 340 =item B<csv-net> I<true|false>
 341
 342 Enable or disable domain network interface stats in CSV output.
 343
 344 =item B<batch> I<true|false>
 345
 346 Sets batch mode.
 347
 348 =item B<secure> I<true|false>
 349
 350 Sets secure mode.
 351
 352 =item B<script> I<true|false>
 353
 354 Sets script mode.
 355
 356 =item B<end-time> I<time>
 357
 358 Set the time at which the program exits.  See above for the
 359 time formats supported.
 360
 361 =item B<overwrite-init-file> I<false>
 362
 363 If set to I<false> then the I<W> key will not overwrite the
 364 init file.
 365
 366 =back
 367
 368
 369 Note that in the current implementation, options specified in
 370 the init file override options specified on the command line.
 371 This is a bug and this behaviour may change in the future.
 372
 373 =head1 SEE ALSO
 374
 375 L<top(1)>,
 376 L<virsh(1)>,
 377 L<http://www.libvirt.org/ocaml/>,
 378 L<http://www.libvirt.org/>,
 379 L<http://people.redhat.com/~rjones/>,
 380 L<http://caml.inria.fr/>
 381
 382 =head1 AUTHORS
 383
 384 Richard W.M. Jones <rjones @ redhat . com>
 385
 386 =head1 COPYRIGHT
 387
 388 (C) Copyright 2007-2011 Red Hat Inc., Richard W.M. Jones
 389 http://libvirt.org/
 390
 391 This program is free software; you can redistribute it and/or modify
 392 it under the terms of the GNU General Public License as published by
 393 the Free Software Foundation; either version 2 of the License, or
 394 (at your option) any later version.
 395
 396 This program is distributed in the hope that it will be useful,
 397 but WITHOUT ANY WARRANTY; without even the implied warranty of
 398 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 399 GNU General Public License for more details.
 400
 401 You should have received a copy of the GNU General Public License
 402 along with this program; if not, write to the Free Software
 403 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 404
 405 =head1 REPORTING BUGS
 406
 407 Bugs can be viewed on the Red Hat Bugzilla page:
 408 L<https://bugzilla.redhat.com/>.
 409
 410 If you find a bug in virt-top, please follow these steps to report it:
 411
 412 =over 4
 413
 414 =item 1. Check for existing bug reports
 415
 416 Go to L<https://bugzilla.redhat.com/> and search for similar bugs.
 417 Someone may already have reported the same bug, and they may even
 418 have fixed it.
 419
 420 =item 2. Capture debug and error messages
 421
 422 Run
 423
 424  virt-top --debug virt-top.log
 425
 426 and keep I<virt-top.log>.  It contains error messages which you
 427 should submit with your bug report.
 428
 429 =item 3. Get version of virt-top and version of libvirt.
 430
 431 Use:
 432
 433  virt-top --version
 434
 435 If you can get the precise version of libvirt you are using
 436 then that too is helpful.
 437
 438 =item 4. Submit a bug report.
 439
 440 Go to L<https://bugzilla.redhat.com/> and enter a new bug.
 441 Please describe the problem in as much detail as possible.
 442
 443 Remember to include the version numbers (step 3) and the debug
 444 messages file (step 2).
 445
 446 =item 5. Assign the bug to rjones @ redhat.com
 447
 448 Assign or reassign the bug to B<rjones @ redhat.com> (without the
 449 spaces).  You can also send me an email with the bug number if you
 450 want a faster response.
 451
 452 =back