bugfix: fixing disableprometheusannotation casing

.chloggen/default-prometheus-annotation-bugfix.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: Changing one of the fields to follow naming conventions with lowerCamelCase
+
+# One or more tracking issues related to the change
+issues: [2608]
+
+# (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/collector_webhook.go

@@ -260,6 +260,10 @@ func (c CollectorWebhook) validate(ctx context.Context, r *OpenTelemetryCollecto
 		maxReplicas = r.Spec.MaxReplicas
 	}
 
+	if r.Spec.Observability.Metrics.DisablePrometheusAnnotations {
+		warnings = append(warnings, "DisablePrometheusAnnotations is deprecated, use DisableAutomaticPrometheusAnnotations instead")
+	}
+
 	var minReplicas *int32
 	if r.Spec.Autoscaler != nil && r.Spec.Autoscaler.MinReplicas != nil {
 		minReplicas = r.Spec.Autoscaler.MinReplicas

apis/v1alpha1/opentelemetrycollector_types.go

@@ -527,7 +527,14 @@ type MetricsConfigSpec struct {
 	//
 	// +optional
 	// +kubebuilder:validation:Optional
+	// Deprecated: use "OpenTelemetryCollector.Spec.Observability.Metrics.DisableAutomaticPrometheusAnnotations" instead
 	DisablePrometheusAnnotations bool `json:"DisablePrometheusAnnotations,omitempty"`
+	// DisableAutomaticPrometheusAnnotations controls the automatic addition of default Prometheus annotations
+	// ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
+	//
+	// +optional
+	// +kubebuilder:validation:Optional
+	DisableAutomaticPrometheusAnnotations bool `json:"disableAutomaticPrometheusAnnotations,omitempty"`
 }
 
 // ObservabilitySpec defines how telemetry data gets handled.

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

@@ -3870,7 +3870,12 @@ spec:
                       DisablePrometheusAnnotations:
                         description: DisablePrometheusAnnotations controls the automatic
                           addition of default Prometheus annotations ('prometheus.io/scrape',
-                          'prometheus.io/port', and 'prometheus.io/path')
+                          'prometheus.io/port', and 'prometheus.
+                        type: boolean
+                      disableAutomaticPrometheusAnnotations:
+                        description: DisableAutomaticPrometheusAnnotations controls
+                          the automatic addition of default Prometheus annotations
+                          ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                         type: boolean
                       enableMetrics:
                         description: EnableMetrics specifies if ServiceMonitor or
@@ -5214,6 +5219,11 @@ spec:
                           DisablePrometheusAnnotations:
                             description: DisablePrometheusAnnotations controls the
                               automatic addition of default Prometheus annotations
+                              ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.
+                            type: boolean
+                          disableAutomaticPrometheusAnnotations:
+                            description: DisableAutomaticPrometheusAnnotations controls
+                              the automatic addition of default Prometheus annotations
                               ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                             type: boolean
                           enableMetrics:

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

@@ -3867,7 +3867,12 @@ spec:
                       DisablePrometheusAnnotations:
                         description: DisablePrometheusAnnotations controls the automatic
                           addition of default Prometheus annotations ('prometheus.io/scrape',
-                          'prometheus.io/port', and 'prometheus.io/path')
+                          'prometheus.io/port', and 'prometheus.
+                        type: boolean
+                      disableAutomaticPrometheusAnnotations:
+                        description: DisableAutomaticPrometheusAnnotations controls
+                          the automatic addition of default Prometheus annotations
+                          ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                         type: boolean
                       enableMetrics:
                         description: EnableMetrics specifies if ServiceMonitor or
@@ -5211,6 +5216,11 @@ spec:
                           DisablePrometheusAnnotations:
                             description: DisablePrometheusAnnotations controls the
                               automatic addition of default Prometheus annotations
+                              ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.
+                            type: boolean
+                          disableAutomaticPrometheusAnnotations:
+                            description: DisableAutomaticPrometheusAnnotations controls
+                              the automatic addition of default Prometheus annotations
                               ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
                             type: boolean
                           enableMetrics:

docs/api.md

@@ -17815,7 +17815,14 @@ Metrics defines the metrics configuration for operands.
         <td><b>DisablePrometheusAnnotations</b></td>
         <td>boolean</td>
         <td>
-          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
+          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>disableAutomaticPrometheusAnnotations</b></td>
+        <td>boolean</td>
+        <td>
+          DisableAutomaticPrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -20325,7 +20332,14 @@ Metrics defines the metrics configuration for operands.
         <td><b>DisablePrometheusAnnotations</b></td>
         <td>boolean</td>
         <td>
-          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
+          DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>disableAutomaticPrometheusAnnotations</b></td>
+        <td>boolean</td>
+        <td>
+          DisableAutomaticPrometheusAnnotations controls the automatic addition of default Prometheus annotations ('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')<br/>
         </td>
         <td>false</td>
       </tr><tr>

internal/manifests/collector/annotations.go

@@ -27,8 +27,25 @@
 	// new map every time, so that we don't touch the instance's annotations
 	annotations := map[string]string{}
 
-	// Enable Prometheus annotations by default if DisablePrometheusAnnotations is nil or true
-	if !instance.Spec.Observability.Metrics.DisablePrometheusAnnotations {
+	var enableAnnotations bool
+	// enableAnnotations is true only if both disable variables are false.
+	// DisableAutomaticPrometheusAnnotations takes precedence over DisablePrometheusAnnotations.
+	if instance.Spec.Observability.Metrics.DisableAutomaticPrometheusAnnotations {
+		enableAnnotations = !instance.Spec.Observability.Metrics.DisableAutomaticPrometheusAnnotations
+	} else if instance.Spec.Observability.Metrics.DisablePrometheusAnnotations {
+		enableAnnotations = !instance.Spec.Observability.Metrics.DisablePrometheusAnnotations
+	} else {
+		enableAnnotations = true
+	}
+	if enableAnnotations {
+		// Set default Prometheus annotations
+		annotations["prometheus.io/scrape"] = "true"
+		annotations["prometheus.io/port"] = "8888"
+		annotations["prometheus.io/path"] = "/metrics"
+	}
+
+	// Enable Prometheus annotations by default if DisablePrometheusAnnotations|DisableAutomaticPrometheusAnnotations is nil or true
+	if !instance.Spec.Observability.Metrics.DisableAutomaticPrometheusAnnotations {
 		// Set default Prometheus annotations
 		annotations["prometheus.io/scrape"] = "true"
 		annotations["prometheus.io/port"] = "8888"

internal/manifests/collector/annotations_test.go

@@ -71,7 +71,8 @@
 		Spec: v1beta1.OpenTelemetryCollectorSpec{
 			Observability: v1beta1.ObservabilitySpec{
 				Metrics: v1beta1.MetricsConfigSpec{
-					DisablePrometheusAnnotations: true,
+					DisablePrometheusAnnotations:          true,
+					DisableAutomaticPrometheusAnnotations: true,
 				},
 			},
 		},