Project: KubeVirt (App Definition and Development / Application Definition & Image Build)
File: metrics.md

<!-- This is an auto-generated file. PLEASE DO NOT EDIT THIS FILE. See "Developing new metrics" below how to generate this file --> This document aims to help users that are not familiar with all metrics exposed by different KubeVirt components. All metrics documented here are auto-generated by the utility tool `tools/doc-generator` and reflects exactly what is being exposed. Version information. The number of allocatable nodes in the cluster. Type: Gauge. The total number of requests to deprecated KubeVirt APIs. Type: Counter. Indicates whether the Software Emulation is enabled in the configuration. Type: Gauge. Amount of active Console connections, broken down by namespace and vmi name. Type: Gauge. The delta between the pod with highest memory working set or rss and its requested memory for each container, virt-controller, virt-handler, virt-api and virt-operator. Type: Gauge. The number of nodes in the cluster that have the devices.kubevirt.io/kvm resource available. Type: Gauge. The number of VMs in the cluster by namespace. Type: Gauge. Amount of active portforward tunnels, broken down by namespace and vmi name. Type: Gauge. Client side rate limiter latency in seconds. Broken down by verb and URL. Type: Histogram. Request latency in seconds. Broken down by verb and URL. Type: Histogram. Number of HTTP requests, partitioned by status code, method, and host. Type: Counter. Amount of active USB redirection connections, broken down by namespace and vmi name. Type: Gauge. The number of virt-api pods that are up. Type: Gauge. Indication for an operating virt-controller. Type: Gauge. The number of virt-controller pods that are ready. Type: Gauge. Indication for a virt-controller that is ready to take the lead. Type: Gauge. The number of virt-controller pods that are up. Type: Gauge. The number of virt-handler pods that are up. Type: Gauge. The number of virt-operator pods that are leading. Type: Gauge. Indication for an operating virt-operator. Type: Gauge. The number of virt-operator pods that are ready. Type: Gauge. Indication for a virt-operator that is ready to take the lead. Type: Gauge. The number of virt-operator pods that are up. Type: Gauge. The current available memory of the VM containers based on the rss. Type: Gauge. The current available memory of the VM containers based on the working set. Type: Gauge. The total number of VMs created by namespace and virt-api pod, since install. Type: Counter. The total number of VMs created by namespace, since install. Type: Counter. Virtual Machine last transition timestamp to error status. Type: Counter. Virtual Machine last transition timestamp to migrating status. Type: Counter. Virtual Machine last transition timestamp to paused/stopped status. Type:

Virtual Machine last transition timestamp to running status. Type: Counter. Virtual Machine last transition timestamp to starting status. Type: Counter. Total CPU time spent in system mode. Type: Counter. Total CPU time spent in all modes (sum of both vcpu and hypervisor usage). Type: Counter. Total CPU time spent in user mode. Type: Counter. Total VM filesystem capacity in bytes. Type: Gauge. Used VM filesystem capacity in bytes. Type: Gauge. Current balloon size in bytes. Type: Gauge. Amount of usable memory as seen by the domain. This value may not be accurate if a balloon driver is in use or if the guest OS does not initialize all assigned pages Type: Gauge. The amount of memory that is being used to cache I/O and is available to be reclaimed, corresponds to the sum of `Buffers` + `Cached` + `SwapCached` in `/proc/meminfo`. Type: Gauge. The amount of memory in bytes allocated to the domain. The `memory` value in domain xml file. Type: Gauge. The number of page faults when disk IO was required. Page faults occur when a process makes a valid access to virtual memory that is not available. When servicing the page fault, if disk IO is required, it is considered as major fault. Type: Counter. The number of other page faults, when disk IO was not required. Page faults occur when a process makes a valid access to virtual memory that is not available. When servicing the page fault, if disk IO is NOT required, it is considered as minor fault. Type: Counter. Resident set size of the process running the domain. Type: Gauge. The total amount of data read from swap space of the guest in bytes. Type: Gauge. The total amount of memory written out to swap space of the guest in bytes. Type: Gauge. The amount of memory left completely unused by the system. Memory that is available but used for reclaimable caches should NOT be reported as free. Type: Gauge. The amount of memory which can be reclaimed by balloon without pushing the guest system to swap, corresponds to 'Available' in /proc/meminfo Type: Gauge. Amount of `used` memory as seen by the domain. Type: Gauge. The total Guest OS data processed and migrated to the new VM. Type: Gauge. The remaining guest OS data to be migrated to the new VM. Type: Gauge. The rate of memory being dirty in the Guest OS. Type: Gauge. The rate at which the memory is being transferred. Type: Gauge. Indicates if the VMI migration failed. Type: Gauge. Histogram of VM migration phase transitions duration from creation time in seconds. Type:

Indicates if the VMI migration succeeded. Type: Gauge. Number of current pending migrations. Type: Gauge. Number of current running migrations. Type: Gauge. Number of current scheduling migrations. Type: Gauge. Total network traffic received in bytes. Type: Counter. Total network received error packets. Type: Counter. The total number of rx packets dropped on vNIC interfaces. Type: Counter. Total network traffic received packets. Type: Counter. Deprecated. Type: Counter. Total network traffic transmitted in bytes. Type: Counter. Total network transmitted error packets. Type: Counter. The total number of tx packets dropped on vNIC interfaces. Type: Counter. Total network traffic transmitted packets. Type: Counter. Number of VMI CPU affinities to node physical cores. Type: Gauge. Indication for a VirtualMachine that its eviction strategy is set to Live Migration but is not migratable. Type: Gauge. Indication for the total number of VirtualMachineInstance workloads that are not running within the most up-to-date version of the virt-launcher environment. Type: Gauge. Sum of VMIs per phase and node. `phase` can be one of the following: [`Pending`, `Scheduling`, `Scheduled`, `Running`, `Succeeded`, `Failed`, `Unknown`]. Type: Gauge. Histogram of VM phase transitions duration from creation time in seconds. Type: Histogram. Histogram of VM phase transitions duration from deletion time in seconds. Type: Histogram. Histogram of VM phase transitions duration between different phases in seconds. Type: Histogram. Total storage flush requests. Type: Counter. Total time spent on cache flushing. Type: Counter. Total number of I/O read operations. Type: Counter. Total number of I/O write operations. Type: Counter. Total time spent on read operations. Type: Counter. Total number of bytes read from storage. Type: Counter. Total time spent on write operations. Type: Counter. Total number of written bytes. Type: Counter. Amount of time spent by each vcpu waiting in the queue instead of running. Type: Counter. Total amount of time spent in each state by each vcpu (cpu_time excluding hypervisor time). Where `id` is the vcpu identifier and `state` can be one of the following: [`OFFLINE`, `RUNNING`, `BLOCKED`]. Type: Counter. Amount of time spent by each vcpu while waiting on I/O. Type: Counter. Returns the total number of virtual machine disks restored from the source virtual machine. Type: Gauge. Returns the amount of space in bytes restored from the source virtual machine. Type: Gauge. Returns the labels of the persistent volume claims that are used for restoring virtual machines. Type: Gauge. Amount of active VNC connections, broken down by namespace and vmi name. Type: Gauge. After developing new metrics or changing old ones, please run `make generate` to regenerate this document. If you feel that the new metric doesn't follow these rules, please change `doc-generator` with your needs.