Create ServiceMonitor to monitor target allocator (#2416)

* add create service monitor to targetallocator

* add chlog

* add e2e test to ta service monitor

* fix linting

* make bundle

* fix chlog

* add a condition to avoid creating sm when running in unsupported modes

* update bundle

* move ta sm ports into ta definition

* remove changes to config/manager

* assert ta service monitor creation in e2e

* enable prometheus feature in e2e test

* change description of observability field

* move ta observability check to build

* add target allocator to builder test

* fix lint

* fix ta sm manifest test

* remove changes to manager kustomization

* make ta sm return directly

* move ta service monitor test to dedicated tests

* remove commands in e2e

* use function to generate label for sm

* ta sm labels in builder test

* fix api.md

* fix bundling

* make api-docs again

* fix kustomization manager

* fix ta service account in test according to fixed issues

Author: changexd

.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: target allocator
+
+# 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

@@ -340,6 +340,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"`
 	// PodDisruptionBudget specifies the pod disruption budget configuration to use
 	// for the target allocator workload.
 	//
@@ -492,7 +498,7 @@ type PodDisruptionBudgetSpec struct {
 
 // MetricsConfigSpec defines a metrics config.
 type MetricsConfigSpec struct {
-	// EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the OpenTelemetry Collector and Prometheus Exporters.
+	// EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator.
 	// The operator.observability.prometheus feature gate must be enabled to use this feature.
 	//
 	// +optional

apis/v1alpha1/zz_generated.deepcopy.go

@@ -65,7 +65,7 @@ metadata:
     categories: Logging & Tracing,Monitoring
     certified: "false"
     containerImage: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-    createdAt: "2023-12-06T14:31:16Z"
+    createdAt: "2023-12-19T02:48:46Z"
     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
@@ -136,11 +136,23 @@ spec:
         displayName: Metrics Config
         path: observability.metrics
       - description: EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar
-          mode) should be created for the OpenTelemetry Collector and Prometheus Exporters.
+          mode) should be created for the service managed by the OpenTelemetry Operator.
           The operator.observability.prometheus 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 or PodMonitor(for sidecar
+          mode) should be created for the service managed by the OpenTelemetry Operator.
+          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-operator.clusterserviceversion.yaml

@@ -3838,8 +3838,8 @@ spec:
                     properties:
                       enableMetrics:
                         description: EnableMetrics specifies if ServiceMonitor or
-                          PodMonitor(for sidecar mode) should be created for the OpenTelemetry
-                          Collector and Prometheus Exporters. The operator.observability.
+                          PodMonitor(for sidecar mode) should be created for the service
+                          managed by the OpenTelemetry Operator. The operator.observability.
                         type: boolean
                     type: object
                 type: object
@@ -5160,6 +5160,22 @@ 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
+                              or PodMonitor(for sidecar mode) should be created for
+                              the service managed by the OpenTelemetry Operator. The
+                              operator.observability.
+                            type: boolean
+                        type: object
+                    type: object
                   podDisruptionBudget:
                     description: PodDisruptionBudget specifies the pod disruption
                       budget configuration to use for the target allocator workload.

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

@@ -3835,8 +3835,8 @@ spec:
                     properties:
                       enableMetrics:
                         description: EnableMetrics specifies if ServiceMonitor or
-                          PodMonitor(for sidecar mode) should be created for the OpenTelemetry
-                          Collector and Prometheus Exporters. The operator.observability.
+                          PodMonitor(for sidecar mode) should be created for the service
+                          managed by the OpenTelemetry Operator. The operator.observability.
                         type: boolean
                     type: object
                 type: object
@@ -5157,6 +5157,22 @@ 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
+                              or PodMonitor(for sidecar mode) should be created for
+                              the service managed by the OpenTelemetry Operator. The
+                              operator.observability.
+                            type: boolean
+                        type: object
+                    type: object
                   podDisruptionBudget:
                     description: PodDisruptionBudget specifies the pod disruption
                       budget configuration to use for the target allocator workload.

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

@@ -82,11 +82,23 @@ spec:
         displayName: Metrics Config
         path: observability.metrics
       - description: EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar
-          mode) should be created for the OpenTelemetry Collector and Prometheus Exporters.
+          mode) should be created for the service managed by the OpenTelemetry Operator.
           The operator.observability.prometheus 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 or PodMonitor(for sidecar
+          mode) should be created for the service managed by the OpenTelemetry Operator.
+          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.