External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-03 03:25:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document caveats of hypervisor-specific stats in 'VIR_DOMAIN_STATS_VCPU' group

Browse Source 
In commit c43718ef67 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>
This commit is contained in:
Peter Krempa 2022-11-28 17:09:23 +01:00
parent 47024d7b2a
commit a421aa76b1
2 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/manpages/virsh.rst
View File

@ -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. host scheduler, but was waiting in the queue instead of running.
Exposed to the VM as a steal time. 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: *--interface* returns:

17
src/libvirt-domain.c
View File

@ -12270,6 +12270,23 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
* instead of running. Exposed to the VM as a steal * instead of running. Exposed to the VM as a steal
* time. * 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
* VIR_DOMAIN_STATS_VM group below.
*
* VIR_DOMAIN_STATS_INTERFACE: * VIR_DOMAIN_STATS_INTERFACE:
* Return network interface statistics (from domain point of view). * Return network interface statistics (from domain point of view).
* The typed parameter keys are in this format: * The typed parameter keys are in this format: