Create ServiceMonitor to monitor target allocator

.chloggen/2311-ta-servicemonitor.yaml

@@ -0,0 +1,16 @@
+# 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. 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: Create ServiceMonitor to monitor target allocator
+
+# One or more tracking issues related to the change
+issues: [2311]
+
+# (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:

apis/v1alpha1/opentelemetrycollector_types.go

@@ -336,6 +336,12 @@ type OpenTelemetryTargetAllocator struct {
 	// consumed in the config file for the TargetAllocator.
 	// +optional
 	Env []v1.EnvVar `json:"env,omitempty"`
+	// ObservabilitySpec defines how telemetry data gets handled.
+	//
+	// +optional
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Observability"
+	Observability ObservabilitySpec `json:"observability,omitempty"`
 }
 
 type OpenTelemetryTargetAllocatorPrometheusCR struct {

bundle/manifests/opentelemetry-operator.clusterserviceversion.yaml

@@ -65,7 +65,7 @@ metadata:
     categories: Logging & Tracing,Monitoring
     certified: "false"
     containerImage: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-    createdAt: "2023-11-17T13:24:32Z"
+    createdAt: "2023-12-05T09:09:57Z"
     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
@@ -140,6 +140,17 @@ spec:
           feature gate must be enabled to use this feature.
         displayName: Create ServiceMonitors for OpenTelemetry Collector
         path: observability.metrics.enableMetrics
+      - description: ObservabilitySpec defines how telemetry data gets handled.
+        displayName: Observability
+        path: targetAllocator.observability
+      - description: Metrics defines the metrics configuration for operands.
+        displayName: Metrics Config
+        path: targetAllocator.observability.metrics
+      - description: EnableMetrics specifies if ServiceMonitor should be created for
+          the OpenTelemetry Collector and Prometheus Exporters. The operator.observability.prometheus
+          feature gate must be enabled to use this feature.
+        displayName: Create ServiceMonitors for OpenTelemetry Collector
+        path: targetAllocator.observability.metrics.enableMetrics
       version: v1alpha1
   description: |-
     OpenTelemetry is a collection of tools, APIs, and SDKs. You use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior.

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

@@ -4966,6 +4966,21 @@ spec:
                     description: NodeSelector to schedule OpenTelemetry TargetAllocator
                       pods.
                     type: object
+                  observability:
+                    description: ObservabilitySpec defines how telemetry data gets
+                      handled.
+                    properties:
+                      metrics:
+                        description: Metrics defines the metrics configuration for
+                          operands.
+                        properties:
+                          enableMetrics:
+                            description: EnableMetrics specifies if ServiceMonitor
+                              should be created for the OpenTelemetry Collector and
+                              Prometheus Exporters. The operator.observability.
+                            type: boolean
+                        type: object
+                    type: object
                   prometheusCR:
                     description: PrometheusCR defines the configuration for the retrieval
                       of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

@@ -4963,6 +4963,21 @@ spec:
                     description: NodeSelector to schedule OpenTelemetry TargetAllocator
                       pods.
                     type: object
+                  observability:
+                    description: ObservabilitySpec defines how telemetry data gets
+                      handled.
+                    properties:
+                      metrics:
+                        description: Metrics defines the metrics configuration for
+                          operands.
+                        properties:
+                          enableMetrics:
+                            description: EnableMetrics specifies if ServiceMonitor
+                              should be created for the OpenTelemetry Collector and
+                              Prometheus Exporters. The operator.observability.
+                            type: boolean
+                        type: object
+                    type: object
                   prometheusCR:
                     description: PrometheusCR defines the configuration for the retrieval
                       of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1

config/manager/kustomization.yaml

@@ -1,2 +1,8 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
+  newTag: 0.89.0

config/manifests/bases/opentelemetry-operator.clusterserviceversion.yaml

@@ -86,6 +86,17 @@ spec:
           feature gate must be enabled to use this feature.
         displayName: Create ServiceMonitors for OpenTelemetry Collector
         path: observability.metrics.enableMetrics
+      - description: ObservabilitySpec defines how telemetry data gets handled.
+        displayName: Observability
+        path: targetAllocator.observability
+      - description: Metrics defines the metrics configuration for operands.
+        displayName: Metrics Config
+        path: targetAllocator.observability.metrics
+      - description: EnableMetrics specifies if ServiceMonitor should be created for
+          the OpenTelemetry Collector and Prometheus Exporters. The operator.observability.prometheus
+          feature gate must be enabled to use this feature.
+        displayName: Create ServiceMonitors for OpenTelemetry Collector
+        path: targetAllocator.observability.metrics.enableMetrics
       version: v1alpha1
   description: |-
     OpenTelemetry is a collection of tools, APIs, and SDKs. You use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior.

docs/api.md

@@ -18060,6 +18060,13 @@ TargetAllocator indicates a value which determines whether to spawn a target all
           NodeSelector to schedule OpenTelemetry TargetAllocator pods.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b><a href="#opentelemetrycollectorspectargetallocatorobservability">observability</a></b></td>
+        <td>object</td>
+        <td>
+          ObservabilitySpec defines how telemetry data gets handled.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b><a href="#opentelemetrycollectorspectargetallocatorprometheuscr">prometheusCR</a></b></td>
         <td>object</td>
@@ -19656,6 +19663,60 @@ Selects a key of a secret in the pod's namespace
 </table>
 
 
+### OpenTelemetryCollector.spec.targetAllocator.observability
+<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator)</sup></sup>
+
+
+
+ObservabilitySpec defines how telemetry data gets handled.
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b><a href="#opentelemetrycollectorspectargetallocatorobservabilitymetrics">metrics</a></b></td>
+        <td>object</td>
+        <td>
+          Metrics defines the metrics configuration for operands.<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>
+
+
+### OpenTelemetryCollector.spec.targetAllocator.observability.metrics
+<sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocatorobservability)</sup></sup>
+
+
+
+Metrics defines the metrics configuration for operands.
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>enableMetrics</b></td>
+        <td>boolean</td>
+        <td>
+          EnableMetrics specifies if ServiceMonitor should be created for the OpenTelemetry Collector and Prometheus Exporters. The operator.observability.<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>
+
+
 ### OpenTelemetryCollector.spec.targetAllocator.prometheusCR
 <sup><sup>[↩ Parent](#opentelemetrycollectorspectargetallocator)</sup></sup>
 

internal/manifests/targetallocator/servicemonitor.go

@@ -0,0 +1,70 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package targetallocator
+
+import (
+	"fmt"
+
+	monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
+	"github.com/open-telemetry/opentelemetry-operator/internal/naming"
+)
+
+// ServiceMonitor returns the service monitor for the given instance.
+func ServiceMonitor(params manifests.Params) (*monitoringv1.ServiceMonitor, error) {
+	if !params.OtelCol.Spec.TargetAllocator.Observability.Metrics.EnableMetrics {
+		params.Log.V(2).Info("Metrics disabled for this OTEL Collector",
+			"params.OtelCol.name", params.OtelCol.Name,
+			"params.OtelCol.namespace", params.OtelCol.Namespace,
+		)
+		return nil, nil
+	}
+
+	sm := monitoringv1.ServiceMonitor{
+		ObjectMeta: metav1.ObjectMeta{
+			Namespace: params.OtelCol.Namespace,
+			Name:      naming.TargetAllocator(params.OtelCol.Name),
+			Labels: map[string]string{
+				"app.kubernetes.io/name":       naming.TargetAllocator(params.OtelCol.Name),
+				"app.kubernetes.io/instance":   fmt.Sprintf("%s.%s", params.OtelCol.Namespace, params.OtelCol.Name),
+				"app.kubernetes.io/managed-by": "opentelemetry-operator",
+				"app.kubernetes.io/component":  "opentelemetry-targetallocator",
+			},
+		},
+		Spec: monitoringv1.ServiceMonitorSpec{
+			Endpoints: []monitoringv1.Endpoint{},
+			NamespaceSelector: monitoringv1.NamespaceSelector{
+				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),
+					"app.kubernetes.io/component":  "opentelemetry-targetallocator",
+				},
+			},
+		},
+	}
+
+	sm.Spec.Endpoints = []monitoringv1.Endpoint{
+		{
+			Port: "targetallocation",
+		},
+	}
+
+	return &sm, nil
+}

internal/manifests/targetallocator/servicemonitor_test.go

@@ -0,0 +1,48 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package targetallocator
+
+import (
+	"testing"
+
+	"github.com/open-telemetry/opentelemetry-operator/internal/config"
+	"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
+	"github.com/open-telemetry/opentelemetry-operator/internal/naming"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDesiredServiceMonitors(t *testing.T) {
+	otelcol := collectorInstance()
+	cfg := config.New()
+
+	params := manifests.Params{
+		OtelCol: otelcol,
+		Config:  cfg,
+		Log:     logger,
+	}
+
+	actual, err := ServiceMonitor(params)
+	assert.NoError(t, err)
+	assert.Nil(t, actual)
+
+	params.OtelCol.Spec.TargetAllocator.Observability.Metrics.EnableMetrics = true
+	actual, err = ServiceMonitor(params)
+	assert.NoError(t, err)
+	assert.NotNil(t, actual)
+	assert.Equal(t, naming.TargetAllocator(params.OtelCol.Name), actual.Name)
+	assert.Equal(t, params.OtelCol.Namespace, actual.Namespace)
+	assert.Equal(t, "targetallocation", actual.Spec.Endpoints[0].Port)
+}

internal/manifests/targetallocator/targetallocator.go

@@ -18,6 +18,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
+	"github.com/open-telemetry/opentelemetry-operator/pkg/featuregate"
 )
 
 // Build creates the manifest for the TargetAllocator resource.
@@ -32,6 +33,11 @@ func Build(params manifests.Params) ([]client.Object, error) {
 		manifests.FactoryWithoutError(ServiceAccount),
 		manifests.FactoryWithoutError(Service),
 	}
+
+	if params.OtelCol.Spec.TargetAllocator.Observability.Metrics.EnableMetrics && featuregate.PrometheusOperatorIsAvailable.IsEnabled() {
+		resourceFactories = append(resourceFactories, manifests.Factory(ServiceMonitor))
+	}
+
 	for _, factory := range resourceFactories {
 		res, err := factory(params)
 		if err != nil {

internal/naming/main.go

@@ -150,6 +150,11 @@ func TargetAllocatorServiceAccount(otelcol string) string {
 	return DNSName(Truncate("%s-targetallocator", 63, otelcol))
 }
 
+// TargetAllocatorServiceMonitor returns the TargetAllocator service account resource name.
+func TargetAllocatorServiceMonitor(otelcol string) string {
+	return DNSName(Truncate("%s-targetallocator", 63, otelcol))
+}
+
 // OpAMPBridgeServiceAccount builds the service account name based on the instance.
 func OpAMPBridgeServiceAccount(opampBridge string) string {
 	return DNSName(Truncate("%s-opamp-bridge", 63, opampBridge))

tests/e2e/targetallocator-prometheuscr/00-install.yaml

@@ -107,6 +107,9 @@ spec:
     image: "local/opentelemetry-operator-targetallocator:e2e"
     prometheusCR:
       enabled: true
+    observability:
+      metrics:
+        enableMetrics: true
   config: |
     receivers:
       prometheus:

tests/e2e/targetallocator-prometheuscr/01-install.yaml

@@ -45,4 +45,20 @@ spec:
           args:
             - /bin/sh
             - -c
-            - curl -s http://prometheus-cr-targetallocator/jobs | grep "prometheus-cr"
+            - curl -s http://prometheus-cr-targetallocator/jobs | grep "prometheus-cr"
+---
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: check-ta-metrics
+spec:
+  template:
+    spec:
+      restartPolicy: OnFailure
+      containers:
+        - name: check-metrics
+          image: curlimages/curl
+          args:
+            - /bin/sh
+            - -c
+            - curl -s http://prometheus-cr-targetallocator/jobs | grep "targetallocator"