From fb3b47ea5b5e278246fcaf4689a7a2e6d6892ca3 Mon Sep 17 00:00:00 2001 From: Hesam Chobanlou Date: Sun, 3 Sep 2017 19:48:28 -0400 Subject: [PATCH] Update docs to include standardization of VM diagnostics VM diagnostics has been updated with v2.48 to include a standard formatting. This change will update the admin documentation to mention the new standard formatting. Change-Id: I2498ae5400ad0903f6084bacaf96f0b76731b5a3 Closes-bug: 1696033 --- ...w-usage-statistics-for-hosts-instances.rst | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst b/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst index 05dc48b579b6..1207f49c7e0e 100644 --- a/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst +++ b/doc/source/admin/common/nova-show-usage-statistics-for-hosts-instances.rst @@ -90,6 +90,57 @@ Show instance usage statistics #. Get diagnostic statistics: + .. note:: + + As of microversion v2.48, diagnostics information for all virt drivers will + have a standard format as below. For more details on diagnostics + response message see `server diagnostics api + `__ + documentation. + + .. code-block:: console + + $ nova diagnostics myCirrosServer + +----------------+------------------------------------------------------------------------+ + | Property | Value | + +----------------+------------------------------------------------------------------------+ + | config_drive | False | + | cpu_details | [] | + | disk_details | [{"read_requests": 887, "errors_count": -1, "read_bytes": 20273152, | + | | "write_requests": 89, "write_bytes": 303104}] | + | driver | libvirt | + | hypervisor | qemu | + | hypervisor_os | linux | + | memory_details | {"used": 0, "maximum": 0} | + | nic_details | [{"rx_packets": 9, "rx_drop": 0, "tx_octets": 1464, "tx_errors": 0, | + | | "mac_address": "fa:16:3e:fa:db:d3", "rx_octets": 958, "rx_rate": null, | + | | "rx_errors": 0, "tx_drop": 0, "tx_packets": 9, "tx_rate": null}] | + | num_cpus | 0 | + | num_disks | 1 | + | num_nics | 1 | + | state | running | + | uptime | 5528 | + +----------------+------------------------------------------------------------------------+ + + ``config_drive`` indicates if the config drive is supported on the + instance. + + ``cpu_details`` contains a list of details per vCPU. + + ``disk_details`` contains a list of details per disk. + + ``driver`` indicates the current driver on which the VM is running. + + ``hypervisor`` indicates the current hypervisor on which the VM is running. + + ``nic_details`` containts a list of details per vNIC. + + ``uptime`` is the amount of time in seconds that the VM has been runnning. + + | + + Diagnostics prior to v2.48: + .. code-block:: console $ nova diagnostics myCirrosServer