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: 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"`
 }
 
 type OpenTelemetryTargetAllocatorPrometheusCR struct {
@@ -487,7 +493,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

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-12-06T14:31:16Z"
+    createdAt: "2023-12-12T02:32:20Z"
     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.io_opentelemetrycollectors.yaml

@@ -3708,8 +3708,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
@@ -4966,6 +4966,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
                   prometheusCR:
                     description: PrometheusCR defines the configuration for the retrieval
                       of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

@@ -3705,8 +3705,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
@@ -4963,6 +4963,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
                   prometheusCR:
                     description: PrometheusCR defines the configuration for the retrieval
                       of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1

config/manifests/bases/opentelemetry-operator.clusterserviceversion.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.