Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-20069

[2109818] Upstream metrics documentation is not detailed enough

XMLWordPrintable

    • CNV Virtualization Sprint 224, CNV Virtualization Sprint 225, CNV Virtualization Sprint 226, CNV Virtualization Sprint 227
    • Important
    • None

      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:

              bmordeha@redhat.com Barak Mordehai
              fdeutsch@redhat.com Fabian Deutsch
              Akriti gupta Akriti gupta
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: