Adding disableautomaticprometheues

Author: rivToadd

.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 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.

internal/manifests/collector/annotations.go

@@ -27,8 +27,8 @@ func Annotations(instance v1beta1.OpenTelemetryCollector) (map[string]string, er
 	// 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 {
+	// Enable Prometheus annotations by default if DisablePrometheusAnnotations|DisableAutomaticPrometheusAnnotations is nil or true
+	if !instance.Spec.Observability.Metrics.DisablePrometheusAnnotations || !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

@@ -73,6 +73,7 @@ func TestNonDefaultPodAnnotation(t *testing.T) {
 			Observability: v1alpha1.ObservabilitySpec{
 				Metrics: v1alpha1.MetricsConfigSpec{
 					DisablePrometheusAnnotations: true,
+					DisableAutomaticPrometheusAnnotations: true,
 				},
 			},
 		},