|
 |
9119d9 |
From cc1fed5d5f7a1fa007ff889bf895aa66653a88ea Mon Sep 17 00:00:00 2001
|
|
|
9119d9 |
Message-Id: <cc1fed5d5f7a1fa007ff889bf895aa66653a88ea@dist-git>
|
|
|
9119d9 |
From: Peter Krempa <pkrempa@redhat.com>
|
|
|
9119d9 |
Date: Wed, 1 Oct 2014 11:20:20 +0200
|
|
|
9119d9 |
Subject: [PATCH] man: virsh: Add docs for supported stats groups
|
|
|
9119d9 |
|
|
|
9119d9 |
https://bugzilla.redhat.com/show_bug.cgi?id=1113116
|
|
|
9119d9 |
|
|
|
9119d9 |
Document the fields returned.
|
|
|
9119d9 |
|
|
|
9119d9 |
(cherry picked from commit 74cf34bc94c5147b217a86f7f0c2686dc86b62bb)
|
|
|
9119d9 |
|
|
|
9119d9 |
Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
|
|
|
9119d9 |
---
|
|
|
9119d9 |
tools/virsh.pod | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
|
|
9119d9 |
1 file changed, 46 insertions(+)
|
|
|
9119d9 |
|
|
|
9119d9 |
diff --git a/tools/virsh.pod b/tools/virsh.pod
|
|
|
9119d9 |
index ea96d64..7d4e497 100644
|
|
|
9119d9 |
--- a/tools/virsh.pod
|
|
|
9119d9 |
+++ b/tools/virsh.pod
|
|
|
9119d9 |
@@ -835,6 +835,52 @@ default all supported statistics groups are returned. Supported
|
|
|
9119d9 |
statistics groups flags are: I<--state>, I<--cpu-total>, I<--balloon>,
|
|
|
9119d9 |
I<--vcpu>, I<--interface>, I<--block>.
|
|
|
9119d9 |
|
|
|
9119d9 |
+When selecting the I<--state> group the following fields are returned:
|
|
|
9119d9 |
+"state.state" - state of the VM, returned as number from virDomainState enum,
|
|
|
9119d9 |
+"state.reason" - reason for entering given state, returned as int from,
|
|
|
9119d9 |
+virDomain*Reason enum corresponding to given state.
|
|
|
9119d9 |
+
|
|
|
9119d9 |
+I<--cpu-total> returns:
|
|
|
9119d9 |
+"cpu.time" - total cpu time spent for this domain in nanoseconds,
|
|
|
9119d9 |
+"cpu.user" - user cpu time spent in nanoseconds,
|
|
|
9119d9 |
+"cpu.system" - system cpu time spent in nanoseconds
|
|
|
9119d9 |
+
|
|
|
9119d9 |
+I<--balloon> returns:
|
|
|
9119d9 |
+"balloon.current" - the memory in kiB currently used,
|
|
|
9119d9 |
+"balloon.maximum" - the maximum memory in kiB allowed
|
|
|
9119d9 |
+
|
|
|
9119d9 |
+I<--vcpu> returns:
|
|
|
9119d9 |
+"vcpu.current" - current number of online virtual CPUs,
|
|
|
9119d9 |
+"vcpu.maximum" - maximum number of online virtual CPUs,
|
|
|
9119d9 |
+"vcpu.<num>.state" - state of the virtual CPU <num>, as number
|
|
|
9119d9 |
+from virVcpuState enum,
|
|
|
9119d9 |
+"vcpu.<num>.time" - virtual cpu time spent by virtual CPU <num>
|
|
|
9119d9 |
+
|
|
|
9119d9 |
+I<--interface> returns:
|
|
|
9119d9 |
+"net.count" - number of network interfaces on this domain,
|
|
|
9119d9 |
+"net.<num>.name" - name of the interface <num>,
|
|
|
9119d9 |
+"net.<num>.rx.bytes" - number of bytes received,
|
|
|
9119d9 |
+"net.<num>.rx.pkts" - number of packets received,
|
|
|
9119d9 |
+"net.<num>.rx.errs" - number of receive errors,
|
|
|
9119d9 |
+"net.<num>.rx.drop" - number of receive packets dropped,
|
|
|
9119d9 |
+"net.<num>.tx.bytes" - number of bytes transmitted,
|
|
|
9119d9 |
+"net.<num>.tx.pkts" - number of packets transmitted,
|
|
|
9119d9 |
+"net.<num>.tx.errs" - number of transmission errors,
|
|
|
9119d9 |
+"net.<num>.tx.drop" - number of transmit packets dropped,
|
|
|
9119d9 |
+
|
|
|
9119d9 |
+I<block> returns:
|
|
|
9119d9 |
+"block.count" - number of block devices on this domain,
|
|
|
9119d9 |
+"block.<num>.name" - name of the target of the block device <num>,
|
|
|
9119d9 |
+"block.<num>.rd.reqs" - number of read requests,
|
|
|
9119d9 |
+"block.<num>.rd.bytes" - number of read bytes,
|
|
|
9119d9 |
+"block.<num>.rd.times" - total time (ns) spent on reads,
|
|
|
9119d9 |
+"block.<num>.wr.reqs" - number of write requests,
|
|
|
9119d9 |
+"block.<num>.wr.bytes" - number of written bytes,
|
|
|
9119d9 |
+"block.<num>.wr.times" - total time (ns) spent on writes,
|
|
|
9119d9 |
+"block.<num>.fl.reqs" - total flush requests,
|
|
|
9119d9 |
+"block.<num>.fl.times" - total time (ns) spent on cache flushing,
|
|
|
9119d9 |
+"block.<num>.errors" - Xen only: the 'oo_req' value,
|
|
|
9119d9 |
+
|
|
|
9119d9 |
Selecting a specific statistics groups doesn't guarantee that the
|
|
|
9119d9 |
daemon supports the selected group of stats. Flag I<--enforce>
|
|
|
9119d9 |
forces the command to fail if the daemon doesn't support the
|
|
|
9119d9 |
--
|
|
|
9119d9 |
2.1.2
|
|
|
9119d9 |
|