From: Peter Krempa <[email protected]>

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 <[email protected]>
---
 docs/formatdomain.rst | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index b5a8f7b714..3c7dbf97db 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -3619,11 +3619,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::

-- 
2.52.0

Reply via email to