update metrics names and dots are used instead of underscores for otel

Signed-off-by: Elieser Pereira <[email protected]>

Author: elieserr

docs/operate.md

@@ -64,14 +64,14 @@ Optional variables
 # Configuring metrics for the KEDA HTTP Add-on Operator
 
 ### Exportable metrics:
-* **operator_http_scaled_object_count** - the number of http_scaled_object  
+* **keda_http_scaled_object_total** - the number of http_scaled_objects  
 
 There are currently 2 supported methods for exposing metrics from the operator - via a Prometheus compatible metrics endpoint or by pushing metrics to a OTEL HTTP collector.
 
 ### Configuring the Prometheus compatible metrics endpoint
 When configured, the operator can expose metrics on a Prometheus compatible endpoint.
 
-This endpoint can be enabled by setting the `OTEL_PROM_EXPORTER_ENABLED` environment variable to `true` on the operator deployment (`true` by default) and by setting `OTEL_PROM_EXPORTER_PORT` to an unused port for the endpoint to be made avaialble on (`2223` by default).
+This endpoint can be enabled by setting the `OTEL_PROM_EXPORTER_ENABLED` environment variable to `true` on the operator deployment (`true` by default) and by setting `OTEL_PROM_EXPORTER_PORT` to an unused port for the endpoint to be made avaialble on (`8080` by default).
 
 ### Configuring the OTEL HTTP exporter
 When configured, the ioperator can export metrics to a OTEL HTTP collector.

operator/metrics/otelmetrics.go

@@ -43,7 +43,7 @@ func NewOtelMetrics(options ...metric.Option) *OtelMetrics {
 	provider := metric.NewMeterProvider(options...)
 	meter := provider.Meter(meterName)
 
-	httpScaledObjectCounter, err := meter.Int64UpDownCounter("operator_http_scaled_object_count", api.WithDescription("a counter of http_scaled_objects processed by the operator"))
+	httpScaledObjectCounter, err := meter.Int64UpDownCounter("keda.http.scaled.object.total", api.WithDescription("a counter of http_scaled_objects processed by the operator"))
 	if err != nil {
 		log.Fatalf("could not create new otelhttpmetric request counter: %v", err)
 	}

operator/metrics/otelmetrics_test.go

@@ -29,7 +29,7 @@ func TestHTTPScaledObjectCount(t *testing.T) {
 	scopeMetrics := got.ScopeMetrics[0]
 	assert.NotEqual(t, len(scopeMetrics.Metrics), 0)
 
-	metricInfo := retrieveMetric(scopeMetrics.Metrics, "operator_http_scaled_object_count")
+	metricInfo := retrieveMetric(scopeMetrics.Metrics, "keda.http.scaled.object.total")
 	data := metricInfo.Data.(metricdata.Sum[int64]).DataPoints[0]
 	assert.Equal(t, data.Value, int64(1))
 }

operator/metrics/prommetrics.go

@@ -42,7 +42,7 @@ func NewPrometheusMetrics(options ...prometheus.Option) *PrometheusMetrics {
 	)
 	meter := provider.Meter(meterName)
 
-	httpScaledObjectCounter, err := meter.Int64UpDownCounter("operator_http_scaled_object_count", api.WithDescription("a counter of http_scaled_objects processed by the operator"))
+	httpScaledObjectCounter, err := meter.Int64UpDownCounter("keda_http_scaled_object_total", api.WithDescription("a counter of http_scaled_objects processed by the operator"))
 	if err != nil {
 		log.Fatalf("could not create new Prometheus request counter: %v", err)
 	}

operator/metrics/prommetrics_test.go

@@ -15,10 +15,10 @@ func TestPromRequestCountMetric(t *testing.T) {
 	options := []promexporter.Option{promexporter.WithRegisterer(testRegistry)}
 	testPrometheus := NewPrometheusMetrics(options...)
 	expectedOutput := `
-	# HELP operator_http_scaled_object_count a counter of http_scaled_objects processed by the operator
-	# TYPE operator_http_scaled_object_count gauge
-	operator_http_scaled_object_count{namespace="test-namespace",otel_scope_name="keda-http-add-on-operator",otel_scope_version=""} 0
-	operator_http_scaled_object_count{namespace="other-test-namespace",otel_scope_name="keda-http-add-on-operator",otel_scope_version=""} 1
+	# HELP keda_http_scaled_object_total a counter of http_scaled_objects processed by the operator
+	# TYPE keda_http_scaled_object_total gauge
+	keda_http_scaled_object_total{namespace="test-namespace",otel_scope_name="keda-http-add-on-operator",otel_scope_version=""} 0
+	keda_http_scaled_object_total{namespace="other-test-namespace",otel_scope_name="keda-http-add-on-operator",otel_scope_version=""} 1
 	# HELP otel_scope_info Instrumentation Scope metadata
 	# TYPE otel_scope_info gauge
 	otel_scope_info{otel_scope_name="keda-http-add-on-operator",otel_scope_version=""} 1

tests/checks/operator_otel_metrics/operator_otel_metrics_test.go

@@ -167,16 +167,16 @@ func TestMetricGeneration(t *testing.T) {
 
 	// Fetch metrics and validate them
 	family := fetchAndParsePrometheusMetrics(t, fmt.Sprintf("curl --insecure %s", otelCollectorPromURL))
-	val, ok := family["operator_http_scaled_object_count"]
+	val, ok := family["keda_http_scaled_object_total"]
 	// If the metric is not found first time around then retry with a delay.
 	if !ok {
 		// Add a small sleep to allow metrics to be pushed from the exporter to the collector
 		time.Sleep(10 * time.Second)
 		// Fetch metrics and validate them
 		family := fetchAndParsePrometheusMetrics(t, fmt.Sprintf("curl --insecure %s", otelCollectorPromURL))
-		val, ok = family["operator_http_scaled_object_count"]
+		val, ok = family["keda_http_scaled_object_total"]
 	}
-	assert.True(t, ok, "operator_http_scaled_object_count is available")
+	assert.True(t, ok, "keda_http_scaled_object_total is available")
 
 	requestCount := getMetricsValue(val)
 	assert.GreaterOrEqual(t, requestCount, float64(1))
@@ -208,7 +208,7 @@ func fetchAndParsePrometheusMetrics(t *testing.T, cmd string) map[string]*prommo
 }
 
 func getMetricsValue(val *prommodel.MetricFamily) float64 {
-	if val.GetName() == "operator_http_scaled_object_count" {
+	if val.GetName() == "keda_http_scaled_object_total" {
 		metrics := val.GetMetric()
 		for _, metric := range metrics {
 			labels := metric.GetLabel()

tests/checks/operator_prometheus_metrics/operator_prometheus_metrics_test.go

@@ -167,8 +167,8 @@ func TestMetricGeneration(t *testing.T) {
 
 	// Fetch metrics and validate them
 	family := fetchAndParsePrometheusMetrics(t, fmt.Sprintf("curl --insecure %s", kedaOperatorPrometheusURL))
-	val, ok := family["operator_http_scaled_object_count"]
-	assert.True(t, ok, "operator_http_scaled_object_count is available")
+	val, ok := family["keda_http_scaled_object_total"]
+	assert.True(t, ok, "keda_http_scaled_object_total is available")
 
 	requestCount := getMetricsValue(val)
 	assert.GreaterOrEqual(t, requestCount, float64(1))
@@ -201,7 +201,7 @@ func fetchAndParsePrometheusMetrics(t *testing.T, cmd string) map[string]*prommo
 }
 
 func getMetricsValue(val *prommodel.MetricFamily) float64 {
-	if val.GetName() == "operator_http_scaled_object_count" {
+	if val.GetName() == "keda_http_scaled_object_total" {
 
 		metrics := val.GetMetric()
 		for _, metric := range metrics {