From ad65b00c1393f7f13e15744e2e1be4fb531e2a17 Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Fri, 30 Jan 2026 17:37:48 +0100 Subject: [PATCH] docs: formatdomain: Reword section about the '' element under disk driver 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 Reviewed-by: Michal Privoznik --- docs/formatdomain.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index d07e4badc3..2a1c821769 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -3625,11 +3625,17 @@ paravirtualized driver is specified via the ``disk`` element. - - The optional ``statistics`` sub-element allows configuring statistics - collection in configurable intervals for the given disk. Intervals are - configured by ```` 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 `__ + typed parameter prefix returned by the + `virConnectGetAllDomainStats `__ + API are collected based on one or more configurable intervals. An interval + of collection is configured by ```` sub-elements with + ``interval`` attribute configuring the collection window duration in + seconds. Example:: -- 2.47.3