Build: (72a3c9a) Merge pull request #370 from kubevirt/gh_actions/update_metrics_docs

Update metrics documentation

Author: machadovilaca

metrics.md

@@ -112,6 +112,7 @@ The following table contains all metrics from operators listed above. Each row r
 | kubevirt | `kubevirt_vmi_storage_read_traffic_bytes_total` | Metric | Counter | Total number of bytes read from storage. |
 | kubevirt | `kubevirt_vmi_storage_write_times_seconds_total` | Metric | Counter | Total time spent on write operations. |
 | kubevirt | `kubevirt_vmi_storage_write_traffic_bytes_total` | Metric | Counter | Total number of written bytes. |
+| kubevirt | `kubevirt_vmi_sync_total` | Metric | Counter | Total number of times a VirtualMachineInstance has been synced. |
 | kubevirt | `kubevirt_vmi_vcpu_delay_seconds_total` | Metric | Counter | Amount of time spent by each vcpu waiting in the queue instead of running. |
 | kubevirt | `kubevirt_vmi_vcpu_seconds_total` | Metric | 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`]. |
 | kubevirt | `kubevirt_vmi_vcpu_wait_seconds_total` | Metric | Counter | Amount of time spent by each vcpu while waiting on I/O. |

runbooks_index.md

@@ -1,98 +1,98 @@
 # KubeVirt Runbooks
 
-- [OrphanedVirtualMachineInstances.md](runbooks/OrphanedVirtualMachineInstances.md)
-- [NoReadyVirtController.md](runbooks/NoReadyVirtController.md)
-- [HAControlPlaneDown.md](runbooks/HAControlPlaneDown.md)
-- [HCOGoldenImageWithNoSupportedArchitecture.md](runbooks/HCOGoldenImageWithNoSupportedArchitecture.md)
-- [VirtControllerDown.md](runbooks/VirtControllerDown.md)
-- [CnaoNmstateMigration.md](runbooks/CnaoNmstateMigration.md)
-- [NodeNetworkInterfaceDown.md](runbooks/NodeNetworkInterfaceDown.md)
-- [HCOGoldenImageWithNoArchitectureAnnotation.md](runbooks/HCOGoldenImageWithNoArchitectureAnnotation.md)
-- [SSPTemplateValidatorDown.md](runbooks/SSPTemplateValidatorDown.md)
+- [VirtAPIDown.md](runbooks/VirtAPIDown.md)
+- [LowKVMNodesCount.md](runbooks/LowKVMNodesCount.md)
+- [HCOInstallationIncomplete.md](runbooks/HCOInstallationIncomplete.md)
+- [PersistentVolumeFillingUp.md](runbooks/PersistentVolumeFillingUp.md)
 - [SSPDown.md](runbooks/SSPDown.md)
-- [CDINotReady.md](runbooks/CDINotReady.md)
-- [VirtualMachineStuckInUnhealthyState.md](runbooks/VirtualMachineStuckInUnhealthyState.md)
+- [CDIDataVolumeUnusualRestartCount.md](runbooks/CDIDataVolumeUnusualRestartCount.md)
 - [HPPOperatorDown.md](runbooks/HPPOperatorDown.md)
-- [VirtOperatorDown.md](runbooks/VirtOperatorDown.md)
-- [KubeVirtDeprecatedAPIRequested.md](runbooks/KubeVirtDeprecatedAPIRequested.md)
-- [OutdatedVirtualMachineInstanceWorkloads.md](runbooks/OutdatedVirtualMachineInstanceWorkloads.md)
-- [CDIDefaultStorageClassDegraded.md](runbooks/CDIDefaultStorageClassDegraded.md)
-- [CDIOperatorDown.md](runbooks/CDIOperatorDown.md)
 - [CDIStorageProfilesIncomplete.md](runbooks/CDIStorageProfilesIncomplete.md)
-- [HCOOperatorConditionsUnhealthy.md](runbooks/HCOOperatorConditionsUnhealthy.md)
-- [LowReadyVirtAPICount.md](runbooks/LowReadyVirtAPICount.md)
-- [CDIDataVolumeUnusualRestartCount.md](runbooks/CDIDataVolumeUnusualRestartCount.md)
-- [KubeVirtCRModified.md](runbooks/KubeVirtCRModified.md)
+- [VirtApiRESTErrorsBurst.md](runbooks/VirtApiRESTErrorsBurst.md)
+- [SSPCommonTemplatesModificationReverted.md](runbooks/SSPCommonTemplatesModificationReverted.md)
+- [OutdatedVirtualMachineInstanceWorkloads.md](runbooks/OutdatedVirtualMachineInstanceWorkloads.md)
+- [VirtualMachineInstanceHasEphemeralHotplugVolume.md](runbooks/VirtualMachineInstanceHasEphemeralHotplugVolume.md)
+- [HighCPUWorkload.md](runbooks/HighCPUWorkload.md)
+- [SSPHighRateRejectedVms.md](runbooks/SSPHighRateRejectedVms.md)
+- [KubeVirtVMGuestMemoryPressure.md](runbooks/KubeVirtVMGuestMemoryPressure.md)
 - [VirtualMachineStuckOnNode.md](runbooks/VirtualMachineStuckOnNode.md)
+- [LowVirtControllersCount.md](runbooks/LowVirtControllersCount.md)
+- [CDIOperatorDown.md](runbooks/CDIOperatorDown.md)
+- [GuestVCPUQueueHighWarning.md](runbooks/GuestVCPUQueueHighWarning.md)
+- [UnsupportedHCOModification.md](runbooks/UnsupportedHCOModification.md)
+- [HAControlPlaneDown.md](runbooks/HAControlPlaneDown.md)
+- [LowReadyVirtControllersCount.md](runbooks/LowReadyVirtControllersCount.md)
+- [OrphanedVirtualMachineInstances.md](runbooks/OrphanedVirtualMachineInstances.md)
 - [LowReadyVirtHandlerCount.md](runbooks/LowReadyVirtHandlerCount.md)
-- [VMStorageClassWarning.md](runbooks/VMStorageClassWarning.md)
-- [VirtHandlerDaemonSetRolloutFailing.md](runbooks/VirtHandlerDaemonSetRolloutFailing.md)
-- [CDINoDefaultStorageClass.md](runbooks/CDINoDefaultStorageClass.md)
 - [KubemacpoolMACCollisionDetected.md](runbooks/KubemacpoolMACCollisionDetected.md)
-- [LowReadyVirtControllersCount.md](runbooks/LowReadyVirtControllersCount.md)
-- [CDIMultipleDefaultVirtStorageClasses.md](runbooks/CDIMultipleDefaultVirtStorageClasses.md)
+- [HCOMisconfiguredDescheduler.md](runbooks/HCOMisconfiguredDescheduler.md)
+- [VirtOperatorRESTErrorsBurst.md](runbooks/VirtOperatorRESTErrorsBurst.md)
+- [CnaoDown.md](runbooks/CnaoDown.md)
+- [HPPSharingPoolPathWithOS.md](runbooks/HPPSharingPoolPathWithOS.md)
+- [LowReadyVirtAPICount.md](runbooks/LowReadyVirtAPICount.md)
 - [VirtHandlerRESTErrorsBurst.md](runbooks/VirtHandlerRESTErrorsBurst.md)
+- [CDIDataImportCronOutdated.md](runbooks/CDIDataImportCronOutdated.md)
+- [NoLeadingVirtOperator.md](runbooks/NoLeadingVirtOperator.md)
+- [NoReadyVirtController.md](runbooks/NoReadyVirtController.md)
+- [VMCannotBeEvicted.md](runbooks/VMCannotBeEvicted.md)
+- [NodeNetworkInterfaceDown.md](runbooks/NodeNetworkInterfaceDown.md)
+- [VirtOperatorDown.md](runbooks/VirtOperatorDown.md)
+- [HCOMultiArchGoldenImagesDisabled.md](runbooks/HCOMultiArchGoldenImagesDisabled.md)
+- [HPPNotReady.md](runbooks/HPPNotReady.md)
+- [CDIDefaultStorageClassDegraded.md](runbooks/CDIDefaultStorageClassDegraded.md)
+- [CDIMultipleDefaultVirtStorageClasses.md](runbooks/CDIMultipleDefaultVirtStorageClasses.md)
+- [SSPTemplateValidatorDown.md](runbooks/SSPTemplateValidatorDown.md)
+- [CnaoNmstateMigration.md](runbooks/CnaoNmstateMigration.md)
+- [KubeVirtDeprecatedAPIRequested.md](runbooks/KubeVirtDeprecatedAPIRequested.md)
+- [HCOGoldenImageWithNoArchitectureAnnotation.md](runbooks/HCOGoldenImageWithNoArchitectureAnnotation.md)
 - [HighNodeCPUFrequency.md](runbooks/HighNodeCPUFrequency.md)
-- [KubeVirtVMGuestMemoryAvailableLow.md](runbooks/KubeVirtVMGuestMemoryAvailableLow.md)
-- [CnaoDown.md](runbooks/CnaoDown.md)
+- [SSPFailingToReconcile.md](runbooks/SSPFailingToReconcile.md)
+- [VMStorageClassWarning.md](runbooks/VMStorageClassWarning.md)
+- [NetworkAddonsConfigNotReady.md](runbooks/NetworkAddonsConfigNotReady.md)
 - [LowVirtOperatorCount.md](runbooks/LowVirtOperatorCount.md)
-- [CDIDataImportCronOutdated.md](runbooks/CDIDataImportCronOutdated.md)
-- [VirtApiRESTErrorsBurst.md](runbooks/VirtApiRESTErrorsBurst.md)
-- [UnsupportedHCOModification.md](runbooks/UnsupportedHCOModification.md)
+- [VirtualMachineStuckInUnhealthyState.md](runbooks/VirtualMachineStuckInUnhealthyState.md)
+- [CDINotReady.md](runbooks/CDINotReady.md)
+- [KubeVirtVMGuestMemoryAvailableLow.md](runbooks/KubeVirtVMGuestMemoryAvailableLow.md)
+- [NoReadyVirtOperator.md](runbooks/NoReadyVirtOperator.md)
 - [NoReadyVirtHandler.md](runbooks/NoReadyVirtHandler.md)
-- [VirtLauncherPodsStuckFailed.md](runbooks/VirtLauncherPodsStuckFailed.md)
-- [HCOMisconfiguredDescheduler.md](runbooks/HCOMisconfiguredDescheduler.md)
-- [HCOMultiArchGoldenImagesDisabled.md](runbooks/HCOMultiArchGoldenImagesDisabled.md)
-- [GuestVCPUQueueHighWarning.md](runbooks/GuestVCPUQueueHighWarning.md)
-- [KubeVirtVMGuestMemoryPressure.md](runbooks/KubeVirtVMGuestMemoryPressure.md)
-- [PersistentVolumeFillingUp.md](runbooks/PersistentVolumeFillingUp.md)
 - [DeprecatedMachineType.md](runbooks/DeprecatedMachineType.md)
-- [SSPFailingToReconcile.md](runbooks/SSPFailingToReconcile.md)
-- [VirtControllerRESTErrorsBurst.md](runbooks/VirtControllerRESTErrorsBurst.md)
-- [HighCPUWorkload.md](runbooks/HighCPUWorkload.md)
-- [LowVirtControllersCount.md](runbooks/LowVirtControllersCount.md)
-- [SSPCommonTemplatesModificationReverted.md](runbooks/SSPCommonTemplatesModificationReverted.md)
-- [HPPSharingPoolPathWithOS.md](runbooks/HPPSharingPoolPathWithOS.md)
-- [HPPNotReady.md](runbooks/HPPNotReady.md)
-- [HCOInstallationIncomplete.md](runbooks/HCOInstallationIncomplete.md)
 - [GuestVCPUQueueHighCritical.md](runbooks/GuestVCPUQueueHighCritical.md)
-- [KubeVirtNoAvailableNodesToRunVMs.md](runbooks/KubeVirtNoAvailableNodesToRunVMs.md)
-- [KubeVirtVMIExcessiveMigrations.md](runbooks/KubeVirtVMIExcessiveMigrations.md)
-- [VirtualMachineInstanceHasEphemeralHotplugVolume.md](runbooks/VirtualMachineInstanceHasEphemeralHotplugVolume.md)
-- [LowReadyVirtOperatorsCount.md](runbooks/LowReadyVirtOperatorsCount.md)
-- [NetworkAddonsConfigNotReady.md](runbooks/NetworkAddonsConfigNotReady.md)
+- [HCOGoldenImageWithNoSupportedArchitecture.md](runbooks/HCOGoldenImageWithNoSupportedArchitecture.md)
+- [CDINoDefaultStorageClass.md](runbooks/CDINoDefaultStorageClass.md)
 - [LowVirtAPICount.md](runbooks/LowVirtAPICount.md)
-- [VirtOperatorRESTErrorsBurst.md](runbooks/VirtOperatorRESTErrorsBurst.md)
-- [LowKVMNodesCount.md](runbooks/LowKVMNodesCount.md)
-- [SSPHighRateRejectedVms.md](runbooks/SSPHighRateRejectedVms.md)
-- [NoReadyVirtOperator.md](runbooks/NoReadyVirtOperator.md)
-- [NoReadyVirtAPI.md](runbooks/NoReadyVirtAPI.md)
-- [KubemacpoolDown.md](runbooks/KubemacpoolDown.md)
+- [KubeVirtCRModified.md](runbooks/KubeVirtCRModified.md)
+- [KubeVirtNoAvailableNodesToRunVMs.md](runbooks/KubeVirtNoAvailableNodesToRunVMs.md)
 - [GuestFilesystemAlmostOutOfSpace.md](runbooks/GuestFilesystemAlmostOutOfSpace.md)
-- [VMCannotBeEvicted.md](runbooks/VMCannotBeEvicted.md)
-- [NoLeadingVirtOperator.md](runbooks/NoLeadingVirtOperator.md)
-- [VirtAPIDown.md](runbooks/VirtAPIDown.md)
 - [VirtHandlerDown.md](runbooks/VirtHandlerDown.md)
+- [NoReadyVirtAPI.md](runbooks/NoReadyVirtAPI.md)
+- [VirtHandlerDaemonSetRolloutFailing.md](runbooks/VirtHandlerDaemonSetRolloutFailing.md)
+- [VirtLauncherPodsStuckFailed.md](runbooks/VirtLauncherPodsStuckFailed.md)
+- [LowReadyVirtOperatorsCount.md](runbooks/LowReadyVirtOperatorsCount.md)
+- [KubeVirtVMIExcessiveMigrations.md](runbooks/KubeVirtVMIExcessiveMigrations.md)
+- [KubemacpoolDown.md](runbooks/KubemacpoolDown.md)
+- [VirtControllerDown.md](runbooks/VirtControllerDown.md)
+- [VirtControllerRESTErrorsBurst.md](runbooks/VirtControllerRESTErrorsBurst.md)
+- [HCOOperatorConditionsUnhealthy.md](runbooks/HCOOperatorConditionsUnhealthy.md)
 
 ## Deprecated Runbooks
 
-- [KubeVirtVMStuckInMigratingState.md](runbooks/KubeVirtVMStuckInMigratingState.md)
-- [VirtHandlerRESTErrorsHigh.md](runbooks/VirtHandlerRESTErrorsHigh.md)
 - [OperatorConditionsUnhealthy.md](runbooks/OperatorConditionsUnhealthy.md)
+- [VirtHandlerRESTErrorsHigh.md](runbooks/VirtHandlerRESTErrorsHigh.md)
 - [KubeVirtVMStuckInErrorState.md](runbooks/KubeVirtVMStuckInErrorState.md)
-- [SingleStackIPv6Unsupported.md](runbooks/SingleStackIPv6Unsupported.md)
 - [KubeMacPoolDown.md](runbooks/KubeMacPoolDown.md)
-- [VirtControllerRESTErrorsHigh.md](runbooks/VirtControllerRESTErrorsHigh.md)
+- [SingleStackIPv6Unsupported.md](runbooks/SingleStackIPv6Unsupported.md)
 - [KubeVirtComponentExceedsRequestedMemory.md](runbooks/KubeVirtComponentExceedsRequestedMemory.md)
-- [SSPOperatorDown.md](runbooks/SSPOperatorDown.md)
-- [VirtOperatorRESTErrorsHigh.md](runbooks/VirtOperatorRESTErrorsHigh.md)
+- [VirtControllerRESTErrorsHigh.md](runbooks/VirtControllerRESTErrorsHigh.md)
+- [KubeVirtComponentExceedsRequestedCPU.md](runbooks/KubeVirtComponentExceedsRequestedCPU.md)
+- [KubeVirtVMStuckInMigratingState.md](runbooks/KubeVirtVMStuckInMigratingState.md)
+- [KubeVirtVMStuckInStartingState.md](runbooks/KubeVirtVMStuckInStartingState.md)
 - [VirtualMachineCRCErrors.md](runbooks/VirtualMachineCRCErrors.md)
-- [KubevirtHyperconvergedClusterOperatorNMOInUseAlert.md](runbooks/KubevirtHyperconvergedClusterOperatorNMOInUseAlert.md)
+- [KubevirtVmHighMemoryUsage.md](runbooks/KubevirtVmHighMemoryUsage.md)
 - [KubeMacPoolDuplicateMacsFound.md](runbooks/KubeMacPoolDuplicateMacsFound.md)
+- [VirtOperatorRESTErrorsHigh.md](runbooks/VirtOperatorRESTErrorsHigh.md)
+- [SSPOperatorDown.md](runbooks/SSPOperatorDown.md)
 - [VirtApiRESTErrorsHigh.md](runbooks/VirtApiRESTErrorsHigh.md)
-- [KubeVirtComponentExceedsRequestedCPU.md](runbooks/KubeVirtComponentExceedsRequestedCPU.md)
-- [KubevirtVmHighMemoryUsage.md](runbooks/KubevirtVmHighMemoryUsage.md)
-- [KubeVirtVMStuckInStartingState.md](runbooks/KubeVirtVMStuckInStartingState.md)
+- [KubevirtHyperconvergedClusterOperatorNMOInUseAlert.md](runbooks/KubevirtHyperconvergedClusterOperatorNMOInUseAlert.md)
 
 ## Renamed Runbooks