[libvirt] [PATCHv6 11/11] man: virsh: Add docs for supported stats groups

Document the fields returned. --- tools/virsh.pod | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/tools/virsh.pod b/tools/virsh.pod index b929480..789641c 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -835,6 +835,53 @@ 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>. +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, +virDomain*Reason enum corresponding to given state. + +I<--cpu-total> returns: +"cpu.time" - total cpu time spent for this domain, +"cpu.user" - user cpu time spent, +"cpu.system" - system cpu time spent + +I<--balloon> returns: +"balloon.current" - the memory in kiB currently used, +"balloon.maximum" - the maximum memory in kiB allowed + +I<--vcpu> returns: +"vcpu.current" - current number of online virtual CPUs as unsigned int, +"vcpu.maximum" - maximum number of online virtual CPUs as unsigned int, +"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> + +I<--interface> returns: +"net.count" - number of network interfaces on this domain, +"net.<num>.name" - name of the interface <num>, +"net.<num>.rx.bytes" - number of bytes received, +"net.<num>.rx.pkts" - number of packets received, +"net.<num>.rx.errs" - number of receive errors, +"net.<num>.rx.drop" - number of receive packets dropped, +"net.<num>.tx.bytes" - number of bytes transmitted, +"net.<num>.tx.pkts" - number of packets transmitted, +"net.<num>.tx.errs" - number of transmission errors, +"net.<num>.tx.drop" - number of transmit packets dropped, + +I<block> returns: +"block.count" - number of block devices on this domain, +"block.<num>.name" - name of the block device <num>, +"block.<num>.rd.reqs" - number of read requests, +"block.<num>.rd.bytes" - number of read bytes, +"block.<num>.rd.times" - total time (ns) spent on reads, +"block.<num>.wr.reqs" - number of write requests, +"block.<num>.wr.bytes" - number of written bytes, +"block.<num>.wr.times" - total time (ns) spent on writes, +"block.<num>.fl.reqs" - total flush requests, +"block.<num>.fl.times" - total time (ns) spent on cache flushing, +"block.<num>.errors" - Xen only: the 'oo_req' value, +"block.<num>.allocation" - offset of the highest written sector + Selecting a specific statistics groups doesn't guarantee that the daemon supports the selected group of stats. Flag I<--enforce> forces the command to fail if the daemon doesn't support the -- 2.1.0