Fix the wrong documentation of two metrics (#4021) (#4031)

The documentation of the
`kubevirt_hco_dataimportcrontemplate_with_architecture_annotation` and
the `kubevirt_hco_dataimportcrontemplate_with_supported_architectures`,
were with the reverse logic (0 <=> 1).

This PR fixes the documentation and the HELP parameter of these metric,
to match the actual logic.

Signed-off-by: Nahshon Unna Tsameret <nunnatsa@redhat.com>
Co-authored-by: Nahshon Unna Tsameret <60659093+nunnatsa@users.noreply.github.com>

Author: kubevirt-bot

controllers/handlers/golden-images/golden_images.go

@@ -84,9 +84,8 @@ func validateMultiArchDict(dict *hcov1beta1.DataImportCronTemplateStatus) bool {
 	if dict.Status.OriginalSupportedArchitectures == "" {
 		metrics.SetDICTWithNoArchitectureAnnotation(dict.Name, dict.Spec.ManagedDataSource)
 		return false
-	} else {
-		metrics.SetDICTWithArchitectureAnnotation(dict.Name, dict.Spec.ManagedDataSource)
 	}
+	metrics.SetDICTWithArchitectureAnnotation(dict.Name, dict.Spec.ManagedDataSource)
 
 	if meta.IsStatusConditionFalse(dict.Status.Conditions, DictConditionDeployedType) {
 		metrics.SetDICTWithNoSupportedArchitectures(dict.Name, dict.Spec.ManagedDataSource)

docs/metrics.md

@@ -7,10 +7,10 @@ Sum of CPU core requests for all running virt-launcher VMIs across the entire Ku
 Monitors resources for potential problems. Type: Gauge.
 
 ### kubevirt_hco_dataimportcrontemplate_with_architecture_annotation
-Indicates whether the DataImportCronTemplate has the ssp.kubevirt.io/dict.architectures annotation (0) or not (1). Type: Gauge.
+Indicates whether the DataImportCronTemplate has the ssp.kubevirt.io/dict.architectures annotation (1) or not (0). Type: Gauge.
 
 ### kubevirt_hco_dataimportcrontemplate_with_supported_architectures
-Indicates whether the DataImportCronTemplate has supported architectures (0) or not (1). Type: Gauge.
+Indicates whether the DataImportCronTemplate has supported architectures (1) or not (0). Type: Gauge.
 
 ### kubevirt_hco_hyperconverged_cr_exists
 Indicates whether the HyperConverged custom resource exists (1) or not (0). Type: Gauge.

hack/prom-rule-ci/hyperconverged-prom-rules-tests.yaml

@@ -843,7 +843,7 @@ tests:
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts: [ ]
 
-    # dict1 metric value of 1 must trigger an alert
+    # dict1 metric value of 0 must trigger an alert
     - eval_time: 2m
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts:
@@ -859,7 +859,7 @@ tests:
             data_import_cron_name: "dict1"
             managed_data_source_name: "ds1"
 
-    # dict1 and dict2 metric values of 1 must trigger alerts
+    # dict1 and dict2 metric values of 0 must trigger alerts
     - eval_time: 3m
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts:
@@ -886,7 +886,7 @@ tests:
             data_import_cron_name: "dict2"
             managed_data_source_name: "ds2"
 
-    # dict1 and dict2 metric values of 1 must trigger alerts
+    # dict1 and dict2 metric values of 0 must trigger alerts
     - eval_time: 4m
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts:
@@ -913,7 +913,7 @@ tests:
             data_import_cron_name: "dict2"
             managed_data_source_name: "ds2"
 
-    # dict2 metric value of 1 must trigger an alert
+    # dict2 metric value of 0 must trigger an alert
     - eval_time: 6m
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts:
@@ -934,7 +934,7 @@ tests:
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts: [ ]
 
-    # dict1 metric value of 1 must trigger an alert
+    # dict1 metric value of 0 must trigger an alert
     - eval_time: 8m
       alertname: HCOGoldenImageWithNoSupportedArchitecture
       exp_alerts:
@@ -966,7 +966,7 @@ tests:
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts: [ ]
 
-    # dict1 metric value of 1 must trigger an alert
+    # dict1 metric value of 0 must trigger an alert
     - eval_time: 2m
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts:
@@ -982,7 +982,7 @@ tests:
             data_import_cron_name: "dict1"
             managed_data_source_name: "ds1"
 
-    # dict1 and dict2 metric values of 1 must trigger alerts
+    # dict1 and dict2 metric values of 0 must trigger alerts
     - eval_time: 3m
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts:
@@ -1009,7 +1009,7 @@ tests:
             data_import_cron_name: "dict2"
             managed_data_source_name: "ds2"
 
-    # dict1 and dict2 metric values of 1 must trigger alerts
+    # dict1 and dict2 metric values of 0 must trigger alerts
     - eval_time: 4m
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts:
@@ -1036,7 +1036,7 @@ tests:
             data_import_cron_name: "dict2"
             managed_data_source_name: "ds2"
 
-    # dict2 metric value of 1 must trigger an alert
+    # dict2 metric value of 0 must trigger an alert
     - eval_time: 6m
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts:
@@ -1057,7 +1057,7 @@ tests:
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts: [ ]
 
-    # dict1 metric value of 1 must trigger an alert
+    # dict1 metric value of 0 must trigger an alert
     - eval_time: 8m
       alertname: HCOGoldenImageWithNoArchitectureAnnotation
       exp_alerts:

pkg/monitoring/hyperconverged/metrics/operator_metrics.go

@@ -76,15 +76,15 @@ var (
 	dictWithSupportedArchitectures = operatormetrics.NewGaugeVec(
 		operatormetrics.MetricOpts{
 			Name: "kubevirt_hco_dataimportcrontemplate_with_supported_architectures",
-			Help: "Indicates whether the DataImportCronTemplate has supported architectures (0) or not (1)",
+			Help: "Indicates whether the DataImportCronTemplate has supported architectures (1) or not (0)",
 		},
 		[]string{counterLabelDICTName, counterLabelDSName},
 	)
 
 	dictWithArchitectureAnnotation = operatormetrics.NewGaugeVec(
 		operatormetrics.MetricOpts{
 			Name: "kubevirt_hco_dataimportcrontemplate_with_architecture_annotation",
-			Help: "Indicates whether the DataImportCronTemplate has the ssp.kubevirt.io/dict.architectures annotation (0) or not (1)",
+			Help: "Indicates whether the DataImportCronTemplate has the ssp.kubevirt.io/dict.architectures annotation (1) or not (0)",
 		},
 		[]string{counterLabelDICTName, counterLabelDSName},
 	)