]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: fix 'virsh domstats --vcpu' measure units and descriptions
authorFabricio Duarte <fabricio.duarte.jr@gmail.com>
Mon, 16 Dec 2024 22:02:44 +0000 (19:02 -0300)
committerMartin Kletzander <mkletzan@redhat.com>
Wed, 5 Feb 2025 16:14:01 +0000 (17:14 +0100)
The fields are in nanoseconds, not microseconds. Also fixes the
description of `vcpu.<num>.wait`, as it does not actually represent the
time waiting on I/O.

Signed-off-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
docs/manpages/virsh.rst

index 868b354b2fae094db64f548501cbbcb1825364cb..cbec1b8ef441b2cb4b6e44739a9fc4feb1997ad9 100644 (file)
@@ -2434,14 +2434,15 @@ When selecting the *--state* group the following fields are returned:
 * ``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)
+  CPU <num> (in nanoseconds)
+* ``vcpu.<num>.wait`` - time the vCPU <num> thread was waiting in the runqueue
+  as the scheduler has something else running ahead of it (in nanoseconds),
+  requires CONFIG_SCHED_INFO on Linux
 * ``vcpu.<num>.halted`` - virtual CPU <num> is halted: yes or
   no (may indicate the processor is idle or even disabled,
   depending on the architecture)
-* ``vcpu.<num>.delay`` - time the vCPU <num> thread was enqueued by the
-  host scheduler, but was waiting in the queue instead of running (in nanoseconds).
+* ``vcpu.<num>.delay`` - time the vCPU <num> thread was waiting in the runqueue
+  as the scheduler has something else running ahead of it (in nanoseconds).
   Exposed to the VM as a steal time.
 
 This group of statistics also reports additional hypervisor-originating per-vCPU