Add e2e test for extra labels

Horiodino · Horiodino · commit a9a621b9b7e3 · 2025-07-11T11:57:17.000+05:30
Signed-off-by: Praful Khanduri &lt;holiodin@gmail.com&gt;
diff --git a/.chloggen/add-servicemonitor-extralabels.yaml b/.chloggen/add-servicemonitor-extralabels.yaml
@@ -0,0 +1,18 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: collector
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add support for extraLabels in ServiceMonitor creation
+
+# One or more tracking issues related to the change
+issues: [4138]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  Added extraLabels field to MetricsConfigSpec in v1beta1 API to allow custom labels on ServiceMonitor resources.
+  This enables users to add additional labels to ServiceMonitors created by the operator for better organization and filtering.
diff --git a/bundle/community/manifests/opentelemetry-operator.clusterserviceversion.yaml b/bundle/community/manifests/opentelemetry-operator.clusterserviceversion.yaml
@@ -99,7 +99,7 @@ metadata:
     categories: Logging & Tracing,Monitoring
     certified: "false"
     containerImage: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-    createdAt: "2025-07-09T10:15:03Z"
+    createdAt: "2025-07-11T06:10:34Z"
     description: Provides the OpenTelemetry components, including the Collector
     operators.operatorframework.io/builder: operator-sdk-v1.29.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
@@ -513,6 +513,8 @@ spec:
                 - --zap-log-level=info
                 - --zap-time-encoding=rfc3339nano
                 - --enable-nginx-instrumentation=true
+                - --target-allocator-image=ghcr.io/open-telemetry/opentelemetry-operator/target-allocator:v0.129.1-12-g537cf331
+                - --operator-opamp-bridge-image=ghcr.io/open-telemetry/opentelemetry-operator/operator-opamp-bridge:v0.129.1-12-g537cf331
                 env:
                 - name: SERVICE_ACCOUNT_NAME
                   valueFrom:
diff --git a/bundle/openshift/manifests/opentelemetry-operator.clusterserviceversion.yaml b/bundle/openshift/manifests/opentelemetry-operator.clusterserviceversion.yaml
@@ -99,7 +99,7 @@ metadata:
     categories: Logging & Tracing,Monitoring
     certified: "false"
     containerImage: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-    createdAt: "2025-07-09T10:15:03Z"
+    createdAt: "2025-07-11T06:10:34Z"
     description: Provides the OpenTelemetry components, including the Collector
     operators.operatorframework.io/builder: operator-sdk-v1.29.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
diff --git a/internal/manifests/collector/servicemonitor.go b/internal/manifests/collector/servicemonitor.go
@@ -50,7 +50,7 @@ func createServiceMonitor(name string, params manifests.Params, serviceType Serv
 
 	labels := manifestutils.Labels(params.OtelCol.ObjectMeta, name, params.OtelCol.Spec.Image, ComponentOpenTelemetryCollector, []string{})
 	// Add extra labels to the ServiceMonitor
-	addExtraLabels(&labels, params.OtelCol.Spec.Observability.Metrics.ExtraLabels)
+	addExtraLabels(&params.Log, &labels, params.OtelCol.Spec.Observability.Metrics.ExtraLabels)
 	selectorLabels := manifestutils.SelectorLabels(params.OtelCol.ObjectMeta, ComponentOpenTelemetryCollector)
 	// This label is the one which differentiates the services
 	selectorLabels[serviceTypeLabel] = serviceType.String()
@@ -115,8 +115,13 @@ func endpointsFromConfig(logger logr.Logger, otelcol v1beta1.OpenTelemetryCollec
 }
 
 // addExtraLabels adds extra labels to the ServiceMonitor labels map.
-func addExtraLabels(labels *map[string]string, extraLabels map[string]string) {
+func addExtraLabels(logger *logr.Logger, labels *map[string]string, extraLabels map[string]string) {
 	for k, v := range extraLabels {
+		if existingValue, exists := (*labels)[k]; exists {
+			if existingValue != v {
+				logger.Info("Overwriting label", "label", k, "old value", existingValue, "new value", v)
+			}
+		}
 		(*labels)[k] = v
 	}
 }
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/01-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/01-install.yaml
@@ -13,6 +13,12 @@ spec:
         protocols:
           grpc:
           http:
+      prometheus:
+        config:
+          scrape_configs:
+          - job_name: 'test-job'
+            static_configs:
+            - targets: ['localhost:9090']
 
     exporters:
       prometheus/prod:
@@ -24,5 +30,5 @@ spec:
     service:
       pipelines:
         metrics:
-          receivers: [otlp]
+          receivers: [otlp, prometheus]
           exporters: [prometheus/dev, prometheus/prod]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/02-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/02-install.yaml
@@ -13,6 +13,12 @@ spec:
         protocols:
           grpc:
           http:
+      prometheus:
+        config:
+          scrape_configs:
+          - job_name: 'test-job'
+            static_configs:
+            - targets: ['localhost:9090']
 
     exporters:
       prometheus/prod:
@@ -21,5 +27,5 @@ spec:
     service:
       pipelines:
         metrics:
-          receivers: [otlp]
+          receivers: [otlp, prometheus]
           exporters: [prometheus/prod]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/03-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/03-install.yaml
@@ -13,6 +13,12 @@ spec:
         protocols:
           grpc:
           http:
+      prometheus:
+        config:
+          scrape_configs:
+          - job_name: 'test-job'
+            static_configs:
+            - targets: ['localhost:9090']
 
     exporters:
       prometheus/prod:
@@ -21,5 +27,5 @@ spec:
     service:
       pipelines:
         metrics:
-          receivers: [otlp]
+          receivers: [otlp, prometheus]
           exporters: [prometheus/prod]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/04-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/04-install.yaml
@@ -13,6 +13,12 @@ spec:
         protocols:
           grpc:
           http:
+      prometheus:
+        config:
+          scrape_configs:
+          - job_name: 'test-job'
+            static_configs:
+            - targets: ['localhost:9090']
 
     exporters:
       prometheus/prod:
@@ -21,5 +27,5 @@ spec:
     service:
       pipelines:
         metrics:
-          receivers: [otlp]
+          receivers: [otlp, prometheus]
           exporters: [prometheus/prod]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/05-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/05-install.yaml
@@ -13,6 +13,12 @@ spec:
         protocols:
           grpc:
           http:
+      prometheus:
+        config:
+          scrape_configs:
+          - job_name: 'test-job'
+            static_configs:
+            - targets: ['localhost:9090']
 
     exporters:
       prometheus/prod:
@@ -27,5 +33,5 @@ spec:
     service:
       pipelines:
         metrics:
-          receivers: [otlp]
+          receivers: [otlp, prometheus]
           exporters: [prometheus/dev, prometheus/prod, prometheusremotewrite/prometheus]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/06-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/06-install.yaml
@@ -13,6 +13,12 @@ spec:
         protocols:
           grpc:
           http:
+      prometheus:
+        config:
+          scrape_configs:
+          - job_name: 'test-job'
+            static_configs:
+            - targets: ['localhost:9090']
 
     exporters:
       prometheus/prod:
@@ -24,5 +30,5 @@ spec:
     service:
       pipelines:
         metrics:
-          receivers: [otlp]
+          receivers: [otlp, prometheus]
           exporters: [prometheus/dev]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/09-assert.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/09-assert.yaml
@@ -0,0 +1,122 @@
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  labels:
+    app.kubernetes.io/component: opentelemetry-collector
+    app.kubernetes.io/instance: create-sm-prometheus.extralabels
+    app.kubernetes.io/managed-by: opentelemetry-operator
+    app.kubernetes.io/name: extralabels-monitoring-collector
+    app.kubernetes.io/part-of: opentelemetry
+    app.kubernetes.io/version: latest
+    environment: test
+    prometheus.io/scrape: "true"
+    team: backend
+  name: extralabels-monitoring-collector
+  namespace: create-sm-prometheus
+spec:
+  endpoints:
+  - port: monitoring
+  namespaceSelector:
+    matchNames:
+    - create-sm-prometheus
+  selector:
+    matchLabels:
+      app.kubernetes.io/component: opentelemetry-collector
+      app.kubernetes.io/instance: create-sm-prometheus.extralabels
+      app.kubernetes.io/managed-by: opentelemetry-operator
+      app.kubernetes.io/part-of: opentelemetry
+      operator.opentelemetry.io/collector-service-type: monitoring
+---
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  labels:
+    app.kubernetes.io/component: opentelemetry-collector
+    app.kubernetes.io/instance: create-sm-prometheus.extralabels
+    app.kubernetes.io/managed-by: opentelemetry-operator
+    app.kubernetes.io/name: extralabels-collector
+    app.kubernetes.io/part-of: opentelemetry
+    app.kubernetes.io/version: latest
+    environment: test
+    prometheus.io/scrape: "true"
+    team: backend
+  name: extralabels-collector
+  namespace: create-sm-prometheus
+spec:
+  endpoints:
+  - port: prometheus-prod
+  namespaceSelector:
+    matchNames:
+    - create-sm-prometheus
+  selector:
+    matchLabels:
+      app.kubernetes.io/component: opentelemetry-collector
+      app.kubernetes.io/instance: create-sm-prometheus.extralabels
+      app.kubernetes.io/managed-by: opentelemetry-operator
+      app.kubernetes.io/part-of: opentelemetry
+      operator.opentelemetry.io/collector-service-type: base
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: extralabels-collector
+  namespace: create-sm-prometheus
+  labels:
+    app.kubernetes.io/component: opentelemetry-collector
+    app.kubernetes.io/instance: create-sm-prometheus.extralabels
+    app.kubernetes.io/managed-by: opentelemetry-operator
+    app.kubernetes.io/name: extralabels-collector
+    app.kubernetes.io/part-of: opentelemetry
+    app.kubernetes.io/version: latest
+    operator.opentelemetry.io/collector-service-type: base
+spec:
+  internalTrafficPolicy: Cluster
+  ports:
+  - appProtocol: grpc
+    name: otlp-grpc
+    port: 4317
+    protocol: TCP
+    targetPort: 4317
+  - appProtocol: http
+    name: otlp-http
+    port: 4318
+    protocol: TCP
+    targetPort: 4318
+  - name: prometheus-prod
+    port: 8884
+    protocol: TCP
+    targetPort: 8884
+  selector:
+    app.kubernetes.io/component: opentelemetry-collector
+    app.kubernetes.io/instance: create-sm-prometheus.extralabels
+    app.kubernetes.io/managed-by: opentelemetry-operator
+    app.kubernetes.io/part-of: opentelemetry
+  type: ClusterIP
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: extralabels-collector-monitoring
+  namespace: create-sm-prometheus
+  labels:
+    app.kubernetes.io/component: opentelemetry-collector
+    app.kubernetes.io/instance: create-sm-prometheus.extralabels
+    app.kubernetes.io/managed-by: opentelemetry-operator
+    app.kubernetes.io/name: extralabels-collector-monitoring
+    app.kubernetes.io/part-of: opentelemetry
+    app.kubernetes.io/version: latest
+    operator.opentelemetry.io/collector-monitoring-service: Exists
+    operator.opentelemetry.io/collector-service-type: monitoring
+spec:
+  internalTrafficPolicy: Cluster
+  ports:
+  - name: monitoring
+    port: 8888
+    protocol: TCP
+    targetPort: 8888
+  selector:
+    app.kubernetes.io/component: opentelemetry-collector
+    app.kubernetes.io/instance: create-sm-prometheus.extralabels
+    app.kubernetes.io/managed-by: opentelemetry-operator
+    app.kubernetes.io/part-of: opentelemetry
+  type: ClusterIP
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/09-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/09-install.yaml
@@ -0,0 +1,27 @@
+apiVersion: opentelemetry.io/v1beta1
+kind: OpenTelemetryCollector
+metadata:
+  name: extralabels
+  namespace: create-sm-prometheus
+spec:
+  observability:
+    metrics:
+      enableMetrics: true
+      extraLabels:
+        prometheus.io/scrape: "true"
+        environment: "test"
+        team: "backend"
+  config:
+    receivers:
+      otlp:
+        protocols:
+          grpc: {}
+          http: {}
+    exporters:
+      prometheus/prod:
+        endpoint: 0.0.0.0:8884
+    service:
+      pipelines:
+        metrics:
+          receivers: [otlp]
+          exporters: [prometheus/prod]
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/10-assert.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/10-assert.yaml
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/10-install.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/10-install.yaml
diff --git a/tests/e2e-prometheuscr/create-sm-prometheus-exporters/chainsaw-test.yaml b/tests/e2e-prometheuscr/create-sm-prometheus-exporters/chainsaw-test.yaml
