]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: formatdomain: Reword section about the '<statistics>' element under disk driver
authorPeter Krempa <pkrempa@redhat.com>
Fri, 30 Jan 2026 16:37:48 +0000 (17:37 +0100)
committerPeter Krempa <pkrempa@redhat.com>
Mon, 16 Feb 2026 09:25:19 +0000 (10:25 +0100)
Separate the timed statistics group and link to the fields which are
returned by it.

Prepare the wording for more statistics configs in the future.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
docs/formatdomain.rst

index d07e4badc3e2a47c555ad710a48cafb870538c00..2a1c821769be8481e0f345fc3ff42a42fd150d9b 100644 (file)
@@ -3625,11 +3625,17 @@ paravirtualized driver is specified via the ``disk`` element.
           </iothreads>
         </driver>
 
-   -  The optional ``statistics`` sub-element allows configuring statistics
-      collection in configurable intervals for the given disk. Intervals are
-      configured by ``<statistic>`` sub-elements with ``interval`` attribute
-      configuring the collection window duration in seconds. The statistics
-      are available via the bulk statistics API.
+   -  The optional ``statistics`` sub-element allows configuring various optional
+      statistics collection.
+
+      Statistic values returned under
+      `VIR_DOMAIN_STATS_BLOCK_SUFFIX_TIMED_GROUP_PREFIX <html/libvirt-libvirt-domain.html#VIR_DOMAIN_STATS_BLOCK_SUFFIX_TIMED_GROUP_PREFIX>`__
+      typed parameter prefix returned by the
+      `virConnectGetAllDomainStats <html/libvirt-libvirt-domain.html#virConnectGetAllDomainStats>`__
+      API are collected based on one or more configurable intervals. An interval
+      of collection is configured by ``<statistic>`` sub-elements with
+      ``interval`` attribute configuring the collection window duration in
+      seconds.
 
       Example::