External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-10-02 04:15:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
c43718ef67
libvirt/tools
History
Peter Krempa c43718ef67 Document caveats of 'VIR_DOMAIN_STATS_VM' group of statistics 
The original patches adding the functionality neglected to add any form
of documentation for the stats fields returned for this group.

The stats are directly converted from qemu's 'query-stats(-schema)' QMP
command without any further interpretation. The 'query-stats-schema' has
the following disclaimer:

 Note: runtime-collected statistics and their names fall outside QEMU's usual
       deprecation policies.  QEMU will try to keep the set of available data
       stable, together with their names, but will not guarantee stability
       at all costs; the same is true of providers that source statistics
       externally, e.g. from Linux.  For example, if the same value is being
       tracked with different names on different architectures or by different
       providers, one of them might be renamed.  A statistic might go away if
       an algorithm is changed or some code is removed; changing a default
       might cause previously useful statistics to always report 0.  Such
       changes, however, are expected to be rare.

Since libvirt is not doing any form of conversion of the stats we can't
meaningfully document any of the returned fields. At the same time we
can't even meaningfully provide any form of API stability for the field
names.

Modify the documentation for the 'VIR_DOMAIN_STATS_VM' group both in the
API docs and in the virsh man page to reflect that and disclaim any form
of stability guarantees we provide normally.

Fixes: 8c9e3dae14
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
2022-11-01 11:56:00 +01:00
..
bash-completion meson: Use dicts to initialize cfg_data objects 2022-04-01 15:33:19 +02:00
nss nss: Compare hostname case insensitive 2022-05-27 13:43:14 +02:00
wireshark meson: Replace meson.source_root() with meson.project_source_root() 2022-10-10 15:06:09 +02:00
libvirt_recover_xattrs.sh tools: fix iterating over argv when recovering xattr 2021-11-30 10:45:35 +00:00
libvirt_win_icon_16x16.ico
libvirt_win_icon_32x32.ico
libvirt_win_icon_48x48.ico
libvirt_win_icon_64x64.ico
libvirt-guests.service.in libvirt-guests: Fix dependency ordering in service file 2022-09-26 13:04:48 +02:00
libvirt-guests.sh.in libvirt-guests: Sync time for autostarted guests 2020-11-04 12:18:05 +01:00
meson.build tools: add virt-qemu-qmp-proxy for proxying QMP via libvirt QEMU guests 2022-10-07 14:32:36 +01:00
virsh_win_icon.rc
virsh-backup.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-backup.h
virsh-checkpoint.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-checkpoint.h
virsh-completer-checkpoint.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-checkpoint.h virsh-completer*.h: Use modern header style 2021-09-17 09:40:46 +02:00
virsh-completer-domain.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-domain.h virsh: Move 'cmdEvent' and all of its machinery to virsh-domain-event.c 2022-03-03 11:06:56 +01:00
virsh-completer-host.c virsh: Add completer for hypervisor-cpu-baseline --model 2022-10-10 14:31:43 +02:00
virsh-completer-host.h virsh: Add completer for hypervisor-cpu-baseline --model 2022-10-10 14:31:43 +02:00
virsh-completer-interface.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-interface.h virsh-completer*.h: Use modern header style 2021-09-17 09:40:46 +02:00
virsh-completer-network.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-network.h virsh: Introduce net-update --section completer 2022-01-19 16:48:33 +01:00
virsh-completer-nodedev.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-nodedev.h virsh: Provide completer for PCI backend drivers 2022-04-04 16:30:48 +02:00
virsh-completer-nwfilter.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-nwfilter.h virsh-completer*.h: Use modern header style 2021-09-17 09:40:46 +02:00
virsh-completer-pool.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-pool.h virsh-completer*.h: Use modern header style 2021-09-17 09:40:46 +02:00
virsh-completer-secret.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-secret.h virsh-completer*.h: Use modern header style 2021-09-17 09:40:46 +02:00
virsh-completer-snapshot.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-snapshot.h virsh-completer*.h: Use modern header style 2021-09-17 09:40:46 +02:00
virsh-completer-volume.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer-volume.h virsh: Provide completer for vol-wipe algorithms 2022-03-11 09:10:24 +01:00
virsh-completer.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-completer.h virsh: Introduce virshEnumComplete() 2022-03-15 13:36:56 +01:00
virsh-console.c util: remove virObjectUnref() adapters 2022-07-15 16:44:39 -05:00
virsh-console.h
virsh-domain-event.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virsh-domain-event.h virsh: Move 'cmdEvent' and all of its machinery to virsh-domain-event.c 2022-03-03 11:06:56 +01:00
virsh-domain-monitor.c Document caveats of 'VIR_DOMAIN_STATS_VM' group of statistics 2022-11-01 11:56:00 +01:00
virsh-domain-monitor.h
virsh-domain.c qemu: Add UNDEFINE_TPM and UNDEFINE_KEEP_TPM flags 2022-10-04 16:34:28 +02:00
virsh-domain.h virsh: Add mode option to domdirtyrate-calc virsh api 2022-02-21 13:34:16 +01:00
virsh-edit.c
virsh-host.c virsh: Add completer for hypervisor-cpu-baseline --model 2022-10-10 14:31:43 +02:00
virsh-host.h virsh-host: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers 2021-07-23 09:59:12 +02:00
virsh-interface.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-interface.h
virsh-network.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-network.h virsh: Introduce net-update --section completer 2022-01-19 16:48:33 +01:00
virsh-nodedev.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-nodedev.h
virsh-nwfilter.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-nwfilter.h
virsh-pool.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-pool.h virsh-pool: Remove static from virshStoragePoolList{Free,Collect} 2021-06-16 10:32:33 +02:00
virsh-secret.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-secret.h tools: remove unnecessary includes 2020-08-03 15:30:40 +02:00
virsh-snapshot.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-snapshot.h tools: remove unnecessary includes 2020-08-03 15:30:40 +02:00
virsh-util.c virsh: Use proper helper for parsing XML in virshDumpXML 2022-10-06 10:54:25 +02:00
virsh-util.h tools: add helper method for printing an XML document 2022-06-20 10:40:34 +01:00
virsh-volume.c virsh: Require --xpath for *dumpxml 2022-07-25 09:50:21 +02:00
virsh-volume.h virsh: Provide completer for vol-wipe algorithms 2022-03-11 09:10:24 +01:00
virsh.c Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
virsh.h virsh: Add --model option for hypervisor-cpu-baseline 2022-10-10 14:31:43 +02:00
virt-admin-completer.c lib: Drop internal virXXXPtr typedefs 2021-04-13 17:00:38 +02:00
virt-admin-completer.h
virt-admin.c virt-admin: Introduce 'daemon-timeout' 2022-07-07 14:35:30 +02:00
virt-admin.h lib: Drop internal virXXXPtr typedefs 2021-04-13 17:00:38 +02:00
virt-host-validate-bhyve.c virt-host-validate-bhyve.c: Reintroduce @ret to virHostValidateBhyve() 2020-05-05 14:45:58 +02:00
virt-host-validate-bhyve.h
virt-host-validate-ch.c tools: virt-host-validate: fix memory leak 2021-11-23 16:59:36 +01:00
virt-host-validate-ch.h tools: add virt-host-validate-ch for ch driver 2021-10-12 17:28:35 +02:00
virt-host-validate-common.c virParseVersionString: rename to virStringParseVersion 2022-02-03 14:10:03 +01:00
virt-host-validate-common.h tools: only fail validations if VIR_HOST_VALIDATE_FAIL is set 2021-06-08 08:52:07 +02:00
virt-host-validate-lxc.c
virt-host-validate-lxc.h
virt-host-validate-qemu.c virt-host-validate: Improve failure message when no HW virt is found 2022-06-01 11:58:09 +02:00
virt-host-validate-qemu.h
virt-host-validate.c tools: add virt-host-validate-ch for ch driver 2021-10-12 17:28:35 +02:00
virt-login-shell-helper.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
virt-login-shell.c
virt-login-shell.conf
virt-pki-query-dn.c tools: Add virt-pki-query-dn binary 2021-11-12 12:37:29 +01:00
virt-pki-validate.in Correct links to TLS certificate setup page 2022-04-25 16:33:01 +02:00
virt-qemu-qmp-proxy tools: add virt-qemu-qmp-proxy for proxying QMP via libvirt QEMU guests 2022-10-07 14:32:36 +01:00
virt-sanlock-cleanup.in
virt-xml-validate.in virt-xml-validate: Fix incorrect wildcards for XML roots 2022-07-07 12:21:16 +02:00
vsh-table.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
vsh-table.h vsh-table: Ensure NULL terminated arguments to vshTable*() 2021-12-17 15:05:58 +01:00
vsh.c tools: Remove unused includes 2022-06-16 06:43:58 +02:00
vsh.h virsh: Add --model option for hypervisor-cpu-baseline 2022-10-10 14:31:43 +02:00