Description of problem: Recording rules are used and displayed as metrics and should be documented. We are currently missing automatic recording rules documentation in https://github.com/kubevirt/kubevirt/blob/main/docs/metrics.md and we have a story open for this CNV-23008. Until it is fixed we need to add the snapshot recording rules manually for kubevirt_vmsnapshot_disks_restored_from_source_total and kubevirt_vmsnapshot_disks_restored_from_source_bytes. Version-Release number of selected component (if applicable): How reproducible: 100% Steps to Reproduce: 1. Go to https://github.com/kubevirt/kubevirt/blob/main/docs/metrics.md and search for the above recording rules. 2. 3. Actual results: No documentation Expected results: New recording rules should be in the metrics.md documentation file. Additional info:
Shirly, with the automatic recording rules in place i believe, what should we do with this one?
The bug is that recording rules were not automatically detected and added to the documentation.
But I see on https://github.com/kubevirt/kubevirt/blob/main/docs/metrics.md that both mentioned rules are described (shortly, but they are). What is there to fix still?
The fix was manually. We need to fix the docs generator so that additional recording rules would be added automatically and not missed.
As agreed, please make sure to include generic fix in the refactoring epic, and then the bug can be closed.
@sradco should we really backport this to 4.12.2 or having it in 4.13.0 will be enough?
No need to a backport. This is fixed.
@sradco shouldn't this be ON_QA by now?
QA, Tested on 4.13.0 https://github.com/kubevirt/kubevirt/blob/main/docs/metrics.md documentation is now updated for both: kubevirt_vmsnapshot_disks_restored_from_source_total and kubevirt_vmsnapshot_disks_restored_from_source_bytes.
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory (Important: OpenShift Virtualization 4.13.3 Images security and bug fix update), and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHSA-2023:4664