Bug 2109818 - Upstream metrics documentation is not detailed enough
Summary: Upstream metrics documentation is not detailed enough
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Virtualization
Version: 4.10.0
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 4.12.0
Assignee: Barak
QA Contact: Akriti Gupta
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-07-22 08:43 UTC by Fabian Deutsch
Modified: 2023-09-18 04:42 UTC (History)
5 users (show)

Fixed In Version: hco-bundle-registry-container-v4.12.0-638
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-01-24 13:38:04 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github kubevirt kubevirt pull 8463 0 None Merged Improve metrics documentation to be detailed enough 2022-10-27 10:03:51 UTC
Red Hat Issue Tracker CNV-20069 0 None None None 2022-10-27 11:49:45 UTC
Red Hat Product Errata RHSA-2023:0408 0 None None None 2023-01-24 13:39:02 UTC

Description Fabian Deutsch 2022-07-22 08:43:36 UTC
Description of problem:
A customer was looking at https://github.com/kubevirt/monitoring/blob/main/docs/metrics.md for learning more about the KubeVirt metrics.
However, some of the descriptions are not helpful.

For example:
"""
kubevirt_vmi_memory_swap_in_traffic_bytes_total
Swap in memory traffic in bytes. Type: Gauge.
"""

Which swap? Inside the quest? Or of the launcher?

Version-Release number of selected component (if applicable):
4.10

How reproducible:
Always

Steps to Reproduce:
1.
2.
3.

Actual results:
Sometimes details, context, and almost allways references/links are missing for metrics documentation.

Expected results:
There is enough details, context, and references/links to further information are provided for every metric.

Additional info:

Comment 2 Akriti Gupta 2022-10-19 15:39:07 UTC
I do not see the chenges takeing effect here https://github.com/kubevirt/monitoring/blob/main/docs/metrics.md
e.g, 
"kubevirt_vmi_cpu_affinity" 
The vcpu affinity details. Type: Counter.

and not

Details the cpu pinning map via boolean labels in the form of vcpu_X_cpu_Y. Type: Counter.

Comment 3 Shirly Radco 2022-10-27 12:37:22 UTC
The https://github.com/kubevirt/monitoring/blob/main/docs/metrics.md is updated

Comment 4 Akriti Gupta 2022-11-17 08:58:50 UTC
https://github.com/kubevirt/monitoring/blob/main/docs/metrics.md is now updated
Moving this bz to verified

Comment 8 errata-xmlrpc 2023-01-24 13:38:04 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.12.0 Images security 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:0408

Comment 9 Red Hat Bugzilla 2023-09-18 04:42:40 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 120 days


Note You need to log in before you can comment on or make changes to this bug.