Bug 2143165

Summary:	Missing documentation for snapshot recording rules
Product:	Container Native Virtualization (CNV)	Reporter:	Shirly Radco <sradco>
Component:	Metrics	Assignee:	Shirly Radco <sradco>
Status:	CLOSED ERRATA	QA Contact:	Ahmad <ahafe>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	4.11.5	CC:	danken, dbasunag, kmajcher, stirabos
Target Milestone:	---
Target Release:	4.13.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-08-16 14:09:56 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Shirly Radco 2022-11-16 09:24:06 UTC

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:

Comment 2 Krzysztof Majcher 2023-02-07 13:44:47 UTC

Shirly, with the automatic recording rules in place i believe, what should we do with this one?

Comment 3 Shirly Radco 2023-02-08 11:17:35 UTC

The bug is that recording rules were not automatically detected and added to the documentation.

Comment 4 Krzysztof Majcher 2023-02-08 14:26:45 UTC

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?

Comment 5 Shirly Radco 2023-02-09 10:13:26 UTC

The fix was manually. We need to fix the docs generator so that additional recording rules would be added automatically and not missed.

Comment 6 Krzysztof Majcher 2023-02-14 11:10:13 UTC

As agreed, please make sure to include generic fix in the refactoring epic, and then the bug can be closed.

Comment 8 Simone Tiraboschi 2023-02-21 13:50:44 UTC

@sradco should we really backport this to 4.12.2 or having it in 4.13.0 will be enough?

Comment 9 Shirly Radco 2023-03-21 14:04:17 UTC

No need to a backport. This is fixed.

Comment 10 Dan Kenigsberg 2023-04-03 08:33:21 UTC

@sradco shouldn't this be ON_QA by now?

Comment 11 Ahmad 2023-05-05 10:03:24 UTC

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.

Comment 19 errata-xmlrpc 2023-08-16 14:09:56 UTC

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