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

[2218468] [CDI] Metrics names failed promlint linter

XMLWordPrintable

    • CNV I/U Operators Sprint 239, CNV I/U Operators Sprint 240, CNV I/U Operators Sprint 241, CNV I/U Operators Sprint 242
    • Moderate
    • No

      Description of problem:
      We created a metric name linter in kubevirt/containerized-data-importer based on promlint: https://github.com/kubevirt/containerized-data-importer/pull/2774.

      This metrics names failed:
      clone_progress: counter metrics should have "_total" or "_timestamp_seconds" suffix
      clone_progress: name need to start with 'kubevirt_'
      kubevirt_cdi_incomplete_storageprofiles_total: non-counter metrics should not have "_total" suffix
      kubevirt_cdi_operator_up_total: non-counter metrics should not have "_total" suffix

      In order to pass the linter the names can be:
      `kubevirt_cdi_incomplete_storageprofiles_total` to `kubevirt_cdi_incomplete_storageprofiles`
      `kubevirt_cdi_operator_up_total` to `kubevirt_cdi_operator_up`

      ***clone_progress will be fixed in: https://github.com/kubevirt/containerized-data-importer/issues/2515 and not in this bug, since also functionally change is needed.

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

      How reproducible:
      100%

      Steps to Reproduce:
      1. cd containerized-data-importer
      2. checkout the pr https://github.com/kubevirt/containerized-data-importer/pull/2774
      3. remove the ignored metrics from excludedMetrics list in
      tools/prom-metrics-collector/metrics_collector.go (in order to see the erros)
      4.make lint-metrics or make test-lint

      Actual results:
      some metric names are not aligned with promlint linter.

      Expected results:
      Metrics named will be aligned with promlint linter and Prometheus best practices.

      Additional info:
      as for now the list of metrics are ignored in the linter.

              alitman@redhat.com Aviv Litman
              alitman@redhat.com Aviv Litman
              Ahmad Hafi Ahmad Hafi
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: