Move clone_progress t list

Since clone_progress metric used for internal purposhould not document it in metri or test it in the metrics linter.
therefore clone_prog (not used by the doc list (not used by the doc and linter generators).

Signed-off-by: Aviv Litman <alitman@alitman-thinkpadp1gen4i.tlv.csb>

cmd/cdi-cloner/clone-source.go

@@ -96,8 +96,8 @@ func startPrometheus() {
 func createProgressReader(readCloser io.ReadCloser, ownerUID string, totalBytes uint64) io.ReadCloser {
 	progress := prometheus.NewCounterVec(
 		prometheus.CounterOpts{
-			Name: monitoring.MetricOptsList[monitoring.CloneProgress].Name,
-			Help: monitoring.MetricOptsList[monitoring.CloneProgress].Help,
+			Name: monitoring.InternalMetricOptsList[monitoring.CloneProgress].Name,
+			Help: monitoring.InternalMetricOptsList[monitoring.CloneProgress].Help,
 		},
 		[]string{"ownerUID"},
 	)

doc/metrics.md

@@ -3,8 +3,6 @@ This document aims to help users that are not familiar with metrics exposed by t
 All metrics documented here are auto-generated by the utility tool `tools/metricsdocs` and reflects exactly what is being exposed.
 
 ## Containerized Data Importer Metrics List
-### clone_progress
-The clone progress in percentage. Type: Counter.
 ### kubevirt_cdi_clone_pods_high_restart
 The number of CDI clone pods with high restart count. Type: Gauge.
 ### kubevirt_cdi_cr_ready

pkg/image/qemu.go

@@ -79,8 +79,8 @@ var (
 
 	progress = prometheus.NewCounterVec(
 		prometheus.CounterOpts{
-			Name: monitoring.MetricOptsList[monitoring.CloneProgress].Name,
-			Help: monitoring.MetricOptsList[monitoring.CloneProgress].Help,
+			Name: monitoring.InternalMetricOptsList[monitoring.CloneProgress].Name,
+			Help: monitoring.InternalMetricOptsList[monitoring.CloneProgress].Help,
 		},
 		[]string{"ownerUID"},
 	)

pkg/importer/format-readers.go

@@ -39,8 +39,8 @@ import (
 var (
 	progress = prometheus.NewCounterVec(
 		prometheus.CounterOpts{
-			Name: monitoring.MetricOptsList[monitoring.CloneProgress].Name,
-			Help: monitoring.MetricOptsList[monitoring.CloneProgress].Help,
+			Name: monitoring.InternalMetricOptsList[monitoring.CloneProgress].Name,
+			Help: monitoring.InternalMetricOptsList[monitoring.CloneProgress].Help,
 		},
 		[]string{"ownerUID"},
 	)

pkg/monitoring/metrics.go

@@ -33,11 +33,6 @@ const (
 
 // MetricOptsList list all CDI metrics
 var MetricOptsList = map[MetricsKey]MetricOpts{
-	CloneProgress: {
-		Name: "clone_progress",
-		Help: "The clone progress in percentage",
-		Type: "Counter",
-	},
 	DataImportCronOutdated: {
 		Name: "kubevirt_cdi_dataimportcron_outdated",
 		Help: "DataImportCron has an outdated import",
@@ -55,6 +50,15 @@ var MetricOptsList = map[MetricsKey]MetricOpts{
 	},
 }
 
+// MetricOptsList list all CDI metrics used for internal purposes only
+var InternalMetricOptsList = map[MetricsKey]MetricOpts{
+	CloneProgress: {
+		Name: "clone_progress",
+		Help: "The clone progress in percentage",
+		Type: "Counter",
+	},
+}
+
 // GetRecordRulesDesc returns CDI Prometheus Record Rules
 func GetRecordRulesDesc(namespace string) []RecordRulesDesc {
 	return []RecordRulesDesc{

tools/prom-metrics-collector/metrics_collector.go

@@ -28,10 +28,8 @@ import (
 
 // This should be used only for very rare cases where the naming conventions that are explained in the best practices:
 // https://sdk.operatorframework.io/docs/best-practices/observability-best-practices/#metrics-guidelines
-// should be ignored, open issue: https://github.com/kubevirt/containerized-data-importer/issues/2515.
-var excludedMetrics = map[string]struct{}{
-	"clone_progress": {},
-}
+// should be ignored.
+var excludedMetrics = map[string]struct{}{}
 
 func recordRulesDescToMetricList(mdl []monitoring.RecordRulesDesc) []monitoring.MetricOpts {
 	res := make([]monitoring.MetricOpts, len(mdl))