aboutsummaryrefslogtreecommitdiff
path: root/scripts/kvm/kvm_stat.texi
blob: 6ce00d80e7a0c4379894818e9f9675e4058bf1b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
@example
@c man begin SYNOPSIS
usage: kvm_stat [OPTION]...
@c man end
@end example

@c man begin DESCRIPTION

kvm_stat prints counts of KVM kernel module trace events.  These events signify
state transitions such as guest mode entry and exit.

This tool is useful for observing guest behavior from the host perspective.
Often conclusions about performance or buggy behavior can be drawn from the
output.

The set of KVM kernel module trace events may be specific to the kernel version
or architecture.  It is best to check the KVM kernel module source code for the
meaning of events.

Note that trace events are counted globally across all running guests.

@c man end

@c man begin OPTIONS
@table @option
@item -1, --once, --batch
  run in batch mode for one second
@item -l, --log
  run in logging mode (like vmstat)
@item -t, --tracepoints
  retrieve statistics from tracepoints
@item -d, --debugfs
  retrieve statistics from debugfs
@item -f, --fields=@var{fields}
  fields to display (regex)
@item -h, --help
  show help message
@end table

@c man end

@ignore

@setfilename kvm_stat
@settitle Report KVM kernel module event counters.

@c man begin AUTHOR
Stefan Hajnoczi <stefanha@redhat.com>
@c man end

@c man begin SEEALSO
perf(1), trace-cmd(1)
@c man end

@end ignore