Add missing label servicemonitor

.chloggen/add-missing-label-servicemonitor.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. operator, target allocator, github action)
+component: operator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Added missing label for Service/Pod Monitors
+
+# One or more tracking issues related to the change
+issues: [2251]
+
+# (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:

internal/manifests/collector/podmonitor.go

@@ -15,7 +15,6 @@
 package collector
 
 import (
-	"fmt"
 	"strings"
 
 	"github.com/go-logr/logr"
@@ -25,10 +24,11 @@ import (
 	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/collector/adapters"
+	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/manifestutils"
 	"github.com/open-telemetry/opentelemetry-operator/internal/naming"
 )
 
-// ServiceMonitor returns the service monitor for the given instance.
+// PodMonitor returns the pod monitor for the given instance.
 func PodMonitor(params manifests.Params) (*monitoringv1.PodMonitor, error) {
 	if !params.OtelCol.Spec.Observability.Metrics.EnableMetrics {
 		params.Log.V(2).Info("Metrics disabled for this OTEL Collector",
@@ -42,16 +42,14 @@ func PodMonitor(params manifests.Params) (*monitoringv1.PodMonitor, error) {
 	if params.OtelCol.Spec.Mode != v1alpha1.ModeSidecar {
 		return nil, nil
 	}
-
+	name := naming.PodMonitor(params.OtelCol.Name)
+	labels := manifestutils.Labels(params.OtelCol.ObjectMeta, name, params.OtelCol.Spec.Image, ComponentOpenTelemetryCollector, []string{})
+	selectorLabels := manifestutils.SelectorLabels(params.OtelCol.ObjectMeta, ComponentOpenTelemetryCollector)
 	pm = monitoringv1.PodMonitor{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: params.OtelCol.Namespace,
-			Name:      naming.PodMonitor(params.OtelCol.Name),
-			Labels: map[string]string{
-				"app.kubernetes.io/name":       naming.PodMonitor(params.OtelCol.Name),
-				"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
-				"app.kubernetes.io/managed-by": "opentelemetry-operator",
-			},
+			Name:      name,
+			Labels:    labels,
 		},
 		Spec: monitoringv1.PodMonitorSpec{
 			JobLabel:        "app.kubernetes.io/instance",
@@ -60,10 +58,7 @@ func PodMonitor(params manifests.Params) (*monitoringv1.PodMonitor, error) {
 				MatchNames: []string{params.OtelCol.Namespace},
 			},
 			Selector: metav1.LabelSelector{
-				MatchLabels: map[string]string{
-					"app.kubernetes.io/managed-by": "opentelemetry-operator",
-					"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
-				},
+				MatchLabels: selectorLabels,
 			},
 			PodMetricsEndpoints: append(
 				[]monitoringv1.PodMetricsEndpoint{

internal/manifests/collector/podmonitor_test.go

@@ -43,17 +43,33 @@ func TestDesiredPodMonitors(t *testing.T) {
 	assert.Equal(t, fmt.Sprintf("%s-collector", params.OtelCol.Name), actual.Name)
 	assert.Equal(t, params.OtelCol.Namespace, actual.Namespace)
 	assert.Equal(t, "monitoring", actual.Spec.PodMetricsEndpoints[0].Port)
+	expectedSelectorLabels := map[string]string{
+		"app.kubernetes.io/component":  "opentelemetry-collector",
+		"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/part-of":    "opentelemetry",
+	}
+	assert.Equal(t, expectedSelectorLabels, actual.Spec.Selector.MatchLabels)
+}
 
-	params, err = newParams("", "testdata/prometheus-exporter.yaml")
+func TestDesiredPodMonitorsWithPrometheus(t *testing.T) {
+	params, err := newParams("", "testdata/prometheus-exporter.yaml")
 	assert.NoError(t, err)
 	params.OtelCol.Spec.Mode = v1alpha1.ModeSidecar
 	params.OtelCol.Spec.Observability.Metrics.EnableMetrics = true
-	actual, err = PodMonitor(params)
+	actual, err := PodMonitor(params)
 	assert.NoError(t, err)
 	assert.NotNil(t, actual)
 	assert.Equal(t, fmt.Sprintf("%s-collector", params.OtelCol.Name), actual.Name)
 	assert.Equal(t, params.OtelCol.Namespace, actual.Namespace)
 	assert.Equal(t, "monitoring", actual.Spec.PodMetricsEndpoints[0].Port)
 	assert.Equal(t, "prometheus-dev", actual.Spec.PodMetricsEndpoints[1].Port)
 	assert.Equal(t, "prometheus-prod", actual.Spec.PodMetricsEndpoints[2].Port)
+	expectedSelectorLabels := map[string]string{
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
+		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/component":  "opentelemetry-collector",
+	}
+	assert.Equal(t, expectedSelectorLabels, actual.Spec.Selector.MatchLabels)
 }

internal/manifests/collector/servicemonitor.go

@@ -15,7 +15,6 @@
 package collector
 
 import (
-	"fmt"
 	"strings"
 
 	"github.com/go-logr/logr"
@@ -25,6 +24,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/collector/adapters"
+	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/manifestutils"
 	"github.com/open-telemetry/opentelemetry-operator/internal/naming"
 )
 
@@ -42,15 +42,14 @@ func ServiceMonitor(params manifests.Params) (*monitoringv1.ServiceMonitor, erro
 	if params.OtelCol.Spec.Mode == v1alpha1.ModeSidecar {
 		return nil, nil
 	}
+	name := naming.ServiceMonitor(params.OtelCol.Name)
+	labels := manifestutils.Labels(params.OtelCol.ObjectMeta, name, params.OtelCol.Spec.Image, ComponentOpenTelemetryCollector, []string{})
+	selectorMatchLabels := manifestutils.SelectorMatchLabels(params.OtelCol.ObjectMeta, ComponentOpenTelemetryCollector)
 	sm = monitoringv1.ServiceMonitor{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: params.OtelCol.Namespace,
-			Name:      naming.ServiceMonitor(params.OtelCol.Name),
-			Labels: map[string]string{
-				"app.kubernetes.io/name":       naming.ServiceMonitor(params.OtelCol.Name),
-				"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
-				"app.kubernetes.io/managed-by": "opentelemetry-operator",
-			},
+			Name:      name,
+			Labels:    labels,
 		},
 		Spec: monitoringv1.ServiceMonitorSpec{
 			Endpoints: append([]monitoringv1.Endpoint{
@@ -62,10 +61,7 @@ func ServiceMonitor(params manifests.Params) (*monitoringv1.ServiceMonitor, erro
 				MatchNames: []string{params.OtelCol.Namespace},
 			},
 			Selector: metav1.LabelSelector{
-				MatchLabels: map[string]string{
-					"app.kubernetes.io/managed-by": "opentelemetry-operator",
-					"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
-				},
+				MatchLabels: selectorMatchLabels,
 			},
 		},
 	}

internal/manifests/collector/servicemonitor_test.go

@@ -35,16 +35,34 @@ func TestDesiredServiceMonitors(t *testing.T) {
 	assert.Equal(t, fmt.Sprintf("%s-collector", params.OtelCol.Name), actual.Name)
 	assert.Equal(t, params.OtelCol.Namespace, actual.Namespace)
 	assert.Equal(t, "monitoring", actual.Spec.Endpoints[0].Port)
+	expectedSelectorLabels := map[string]string{
+		"app.kubernetes.io/component":  "opentelemetry-collector",
+		"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/name":       fmt.Sprintf("%s-monitoring", params.OtelCol.Name),
+	}
+	assert.Equal(t, expectedSelectorLabels, actual.Spec.Selector.MatchLabels)
+}
 
-	params, err = newParams("", "testdata/prometheus-exporter.yaml")
+func TestDesiredServiceMonitorsWithPrometheus(t *testing.T) {
+	params, err := newParams("", "testdata/prometheus-exporter.yaml")
 	assert.NoError(t, err)
 	params.OtelCol.Spec.Observability.Metrics.EnableMetrics = true
-	actual, err = ServiceMonitor(params)
+	actual, err := ServiceMonitor(params)
 	assert.NoError(t, err)
 	assert.NotNil(t, actual)
 	assert.Equal(t, fmt.Sprintf("%s-collector", params.OtelCol.Name), actual.Name)
 	assert.Equal(t, params.OtelCol.Namespace, actual.Namespace)
 	assert.Equal(t, "monitoring", actual.Spec.Endpoints[0].Port)
 	assert.Equal(t, "prometheus-dev", actual.Spec.Endpoints[1].Port)
 	assert.Equal(t, "prometheus-prod", actual.Spec.Endpoints[2].Port)
+	expectedSelectorLabels := map[string]string{
+		"app.kubernetes.io/component":  "opentelemetry-collector",
+		"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/name":       fmt.Sprintf("%s-monitoring", params.OtelCol.Name),
+	}
+	assert.Equal(t, expectedSelectorLabels, actual.Spec.Selector.MatchLabels)
 }

internal/manifests/manifestutils/labels.go

@@ -15,6 +15,7 @@
 package manifestutils
 
 import (
+	"fmt"
 	"regexp"
 	"strings"
 
@@ -81,3 +82,14 @@ func SelectorLabels(instance metav1.ObjectMeta, component string) map[string]str
 		"app.kubernetes.io/component":  component,
 	}
 }
+
+// SelectorMatchLabels return the common labels that should be used on ServiceMonitor when the Spec.Observability.Metrics.EnableMetrics is true.
+func SelectorMatchLabels(instance metav1.ObjectMeta, component string) map[string]string {
+	return map[string]string{
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/instance":   naming.Truncate("%s.%s", 63, instance.Namespace, instance.Name),
+		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/component":  component,
+		"app.kubernetes.io/name":       fmt.Sprintf("%s-monitoring", instance.Name),
+	}
+}

internal/manifests/manifestutils/labels_test.go

@@ -168,3 +168,23 @@ func TestSelectorLabels(t *testing.T) {
 	// verify
 	assert.Equal(t, expected, result)
 }
+
+func TestSelectorMatchLabels(t *testing.T) {
+	// prepare
+	expected := map[string]string{
+		"app.kubernetes.io/component":  "opentelemetry-collector",
+		"app.kubernetes.io/instance":   "my-namespace.my-opentelemetry-collector",
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/name":       "my-opentelemetry-collector-monitoring",
+	}
+	otelcol := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{Name: "my-opentelemetry-collector", Namespace: "my-namespace"},
+	}
+
+	// test
+	result := SelectorMatchLabels(otelcol.ObjectMeta, "opentelemetry-collector")
+
+	// verify
+	assert.Equal(t, expected, result)
+}

tests/e2e-prometheuscr/create-pm-prometheus-exporters/01-assert.yaml

@@ -42,3 +42,4 @@ spec:
     matchLabels:
       app.kubernetes.io/managed-by: opentelemetry-operator
       app.kubernetes.io/instance: create-pm-prometheus.simplest
+      app.kubernetes.io/name: simplest-collector-monitoring

tests/e2e-prometheuscr/create-sm-prometheus-exporters/01-assert.yaml

@@ -19,6 +19,7 @@ spec:
     matchLabels:
       app.kubernetes.io/managed-by: opentelemetry-operator
       app.kubernetes.io/instance: create-sm-prometheus.simplest
+      app.kubernetes.io/name: simplest-collector-monitoring
 ---
 apiVersion: v1
 kind: Service

tests/e2e-prometheuscr/create-sm-prometheus-exporters/02-assert.yaml

@@ -18,6 +18,7 @@ spec:
     matchLabels:
       app.kubernetes.io/managed-by: opentelemetry-operator
       app.kubernetes.io/instance: create-sm-prometheus.simplest
+      app.kubernetes.io/name: simplest-collector-monitoring
 ---
 apiVersion: v1
 kind: Service

tests/e2e-prometheuscr/create-sm-prometheus-exporters/05-assert.yaml

@@ -19,3 +19,4 @@ spec:
     matchLabels:
       app.kubernetes.io/managed-by: opentelemetry-operator
       app.kubernetes.io/instance: create-sm-prometheus.simplest
+      app.kubernetes.io/name: simplest-collector-monitoring

tests/e2e-prometheuscr/create-sm-prometheus-exporters/06-assert.yaml

@@ -18,3 +18,4 @@ spec:
     matchLabels:
       app.kubernetes.io/managed-by: opentelemetry-operator
       app.kubernetes.io/instance: create-sm-prometheus.simplest
+      app.kubernetes.io/name: simplest-collector-monitoring