diff options
| author | Peter Krempa <pkrempa@redhat.com> | 2022-11-28 17:09:23 +0100 |
|---|---|---|
| committer | Peter Krempa <pkrempa@redhat.com> | 2022-11-29 09:36:10 +0100 |
| commit | a421aa76b1b74d6b307b273f902bd929989ab6e5 (patch) | |
| tree | a002365c363c45c45bebd5a74075d24df849d9e9 /docs/manpages | |
| parent | 47024d7b2a00ea85b30f767407b29ecfd7687245 (diff) | |
| download | libvirt-a421aa76b1b74d6b307b273f902bd929989ab6e5.tar.gz | |
Document caveats of hypervisor-specific stats in 'VIR_DOMAIN_STATS_VCPU' groupv8.10.0-rc2
In commit c43718ef67944 I've added a disclaimer that the new stats which
are fetched from qemu and passed directly to the user are not guaranteed
by libvirt. I didn't notice that per-vcpu hypervisor specific stats are
also snuck into the VIR_DOMAIN_STATS_VCPU group along with other
pre-existing stats we do guarantee.
Extend the disclaimer for VIR_DOMAIN_STATS_VCPU too.
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
Diffstat (limited to 'docs/manpages')
| -rw-r--r-- | docs/manpages/virsh.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index 5f5f48f83e..1e8a43bc55 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -2399,6 +2399,28 @@ When selecting the *--state* group the following fields are returned: host scheduler, but was waiting in the queue instead of running. Exposed to the VM as a steal time. +This group of statistics also reports additional hypervisor-originating per-vCPU +stats. The hypervisor-specific statistics in this group have the following +naming scheme: + + ``vcpu.<num>.$NAME.$TYPE`` + + ``$NAME`` + name of the statistics field provided by the hypervisor + + ``$TYPE`` + Type of the value. The following types are returned: + + ``cur`` + current instant value + ``sum`` + aggregate value + ``max`` + peak value + + The returned value may be either an unsigned long long or a boolean. Meaning + is hypervisor specific. Please see the disclaimer for the *--vm* group which + also consists of hypervisor-specific stats. *--interface* returns: |