0001 kvm_stat(1)
0002 ===========
0003
0004 NAME
0005 ----
0006 kvm_stat - Report KVM kernel module event counters
0007
0008 SYNOPSIS
0009 --------
0010 [verse]
0011 'kvm_stat' [OPTION]...
0012
0013 DESCRIPTION
0014 -----------
0015 kvm_stat prints counts of KVM kernel module trace events. These events signify
0016 state transitions such as guest mode entry and exit.
0017
0018 This tool is useful for observing guest behavior from the host perspective.
0019 Often conclusions about performance or buggy behavior can be drawn from the
0020 output.
0021 While running in regular mode, use any of the keys listed in section
0022 'Interactive Commands' below.
0023 Use batch and logging modes for scripting purposes.
0024
0025 The set of KVM kernel module trace events may be specific to the kernel version
0026 or architecture. It is best to check the KVM kernel module source code for the
0027 meaning of events.
0028
0029 INTERACTIVE COMMANDS
0030 --------------------
0031 [horizontal]
0032 *b*:: toggle events by guests (debugfs only, honors filters)
0033
0034 *c*:: clear filter
0035
0036 *f*:: filter by regular expression
0037 :: *Note*: Child events pull in their parents, and parents' stats summarize
0038 all child events, not just the filtered ones
0039
0040 *g*:: filter by guest name/PID
0041
0042 *h*:: display interactive commands reference
0043
0044 *o*:: toggle sorting order (Total vs CurAvg/s)
0045
0046 *p*:: filter by guest name/PID
0047
0048 *q*:: quit
0049
0050 *r*:: reset stats
0051
0052 *s*:: set delay between refreshs
0053
0054 *x*:: toggle reporting of stats for child trace events
0055 :: *Note*: The stats for the parents summarize the respective child trace
0056 events
0057
0058 Press any other key to refresh statistics immediately.
0059
0060 OPTIONS
0061 -------
0062 -1::
0063 --once::
0064 --batch::
0065 run in batch mode for one second
0066
0067 -c::
0068 --csv::
0069 log in csv format. Requires option -l/--log or -L/--log-to-file.
0070 When used with option -L/--log-to-file, the header is only ever
0071 written to start of file to preserve the format.
0072
0073 -d::
0074 --debugfs::
0075 retrieve statistics from debugfs
0076
0077 -f<fields>::
0078 --fields=<fields>::
0079 fields to display (regex), "-f help" for a list of available events
0080
0081 -g<guest>::
0082 --guest=<guest_name>::
0083 limit statistics to one virtual machine (guest name)
0084
0085 -h::
0086 --help::
0087 show help message
0088
0089 -i::
0090 --debugfs-include-past::
0091 include all available data on past events for debugfs
0092
0093 -l::
0094 --log::
0095 run in logging mode (like vmstat)
0096
0097
0098 -L<file>::
0099 --log-to-file=<file>::
0100 like -l/--log, but logging to a file. Appends to existing files.
0101
0102 -p<pid>::
0103 --pid=<pid>::
0104 limit statistics to one virtual machine (pid)
0105
0106 -s::
0107 --set-delay::
0108 set delay between refreshs (value range: 0.1-25.5 secs)
0109
0110 -t::
0111 --tracepoints::
0112 retrieve statistics from tracepoints
0113
0114 -z::
0115 --skip-zero-records::
0116 omit records with all zeros in logging mode
0117
0118 SEE ALSO
0119 --------
0120 'perf'(1), 'trace-cmd'(1)
0121
0122 AUTHOR
0123 ------
0124 Stefan Hajnoczi <stefanha@redhat.com>
