From: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
Date: Thu, 13 Oct 2016 11:42:47 +0000 (+0200)
Subject: doc: update virsh domstats documentation for vcpu statistics
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=c1be22f971e3aa58afada294066c7636ad624db4;p=libvirt.git

doc: update virsh domstats documentation for vcpu statistics

Added description for new vcpu.<num>.halted statistics value.
While there, also added a description for vcpu.<num>.wait and
clarified the units displayed for time and wait.

Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
Reviewed-by: Bjoern Walk <bwalk@linux.vnet.ibm.com>
---

diff --git a/tools/virsh.pod b/tools/virsh.pod
index a18eaf4c28..62c592cf62 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -887,6 +887,9 @@ default all supported statistics groups are returned. Supported
 statistics groups flags are: I<--state>, I<--cpu-total>, I<--balloon>,
 I<--vcpu>, I<--interface>, I<--block>, I<--perf>.
 
+Note that - depending on the hypervisor type and version or the domain state
+- not all of the following statistics may be returned.
+
 When selecting the I<--state> group the following fields are returned:
 "state.state" - state of the VM, returned as number from virDomainState enum,
 "state.reason" - reason for entering given state, returned as int from
@@ -917,6 +920,11 @@ I<--vcpu> returns:
 "vcpu.<num>.state" - state of the virtual CPU <num>, as number
 from virVcpuState enum,
 "vcpu.<num>.time" - virtual cpu time spent by virtual CPU <num>
+ (in microseconds),
+"vcpu.<num>.wait" - virtual cpu time spent by virtual CPU <num>
+waiting on I/O (in microseconds),
+"vcpu.<num>.halted" - virtual CPU <num> is halted: yes or no (may indicate
+the processor is idle or even disabled, depending on the architecture)
 
 I<--interface> returns:
 "net.count" - number of network interfaces on this domain,