Add regex validation for the name of the batch of custom queries being added, according to OTel component naming restrictions.

Author: dsessler7

config/crd/bases/postgres-operator.crunchydata.com_pgadmins.yaml

@@ -2066,7 +2066,11 @@ spec:
                                   x-kubernetes-validations:
                                   - rule: duration("0") <= self && self <= duration("60m")
                                 name:
-                                  description: The name of this batch of queries.
+                                  description: |-
+                                    The name of this batch of queries, which will be used in naming the OTel
+                                    SqlQuery receiver.
+                                  maxLength: 20
+                                  pattern: ^[^\pZ\pC\pS]+$
                                   type: string
                                 queries:
                                   description: A ConfigMap holding the yaml file that

config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -11722,7 +11722,11 @@ spec:
                                   x-kubernetes-validations:
                                   - rule: duration("0") <= self && self <= duration("60m")
                                 name:
-                                  description: The name of this batch of queries.
+                                  description: |-
+                                    The name of this batch of queries, which will be used in naming the OTel
+                                    SqlQuery receiver.
+                                  maxLength: 20
+                                  pattern: ^[^\pZ\pC\pS]+$
                                   type: string
                                 queries:
                                   description: A ConfigMap holding the yaml file that

pkg/apis/postgres-operator.crunchydata.com/v1beta1/instrumentation_types.go

@@ -11,22 +11,27 @@ import corev1 "k8s.io/api/core/v1"
 type InstrumentationSpec struct {
 	// Image name to use for collector containers. When omitted, the value
 	// comes from an operator environment variable.
+	// ---
 	// +optional
 	Image string `json:"image,omitempty"`
 
 	// Resources holds the resource requirements for the collector container.
+	// ---
 	// +optional
 	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
 
 	// Config is the place for users to configure exporters and provide files.
+	// ---
 	// +optional
 	Config *InstrumentationConfigSpec `json:"config,omitempty"`
 
 	// Logs is the place for users to configure the log collection.
+	// ---
 	// +optional
 	Logs *InstrumentationLogsSpec `json:"logs,omitempty"`
 
 	// Metrics is the place for users to configure metrics collection.
+	// ---
 	// +optional
 	Metrics *InstrumentationMetricsSpec `json:"metrics,omitempty"`
 }
@@ -46,6 +51,7 @@ type InstrumentationConfigSpec struct {
 
 	// Exporters allows users to configure OpenTelemetry exporters that exist
 	// in the collector image.
+	// ---
 	// +kubebuilder:pruning:PreserveUnknownFields
 	// +kubebuilder:validation:Schemaless
 	// +kubebuilder:validation:Type=object
@@ -98,30 +104,41 @@ type InstrumentationLogsSpec struct {
 type InstrumentationMetricsSpec struct {
 	// Where users can turn off built-in metrics and also provide their own
 	// custom queries.
+	// ---
 	// +optional
 	CustomQueries *InstrumentationCustomQueriesSpec `json:"customQueries,omitempty"`
 }
 
 type InstrumentationCustomQueriesSpec struct {
 	// User defined queries and metrics.
+	// ---
 	// +optional
 	Add []InstrumentationCustomQueries `json:"add,omitempty"`
 
 	// A list of built-in queries that should be removed. If all queries for a
 	// given SQL statement are removed, the SQL statement will no longer be run.
-	//
+	// ---
 	// +optional
 	Remove []string `json:"remove,omitempty"`
 }
 
 type InstrumentationCustomQueries struct {
-	// The name of this batch of queries.
+	// The name of this batch of queries, which will be used in naming the OTel
+	// SqlQuery receiver.
+	// ---
+	// OTel restricts component names from having whitespace, control characters,
+	// or symbols.
+	// https://github.com/open-telemetry/opentelemetry-collector/blob/main/component/identifiable.go#L23-L26
+	// +kubebuilder:validation:Pattern=`^[^\pZ\pC\pS]+$`
+	//
+	// Set a max length to keep rule costs low.
+	// +kubebuilder:validation:MaxLength=20
 	//
 	// +required
 	Name string `json:"name"`
 
 	// A ConfigMap holding the yaml file that contains the queries.
-	//
+	// ---
 	// +required
 	Queries ConfigMapKeyRef `json:"queries"`
 
@@ -147,7 +164,7 @@ type InstrumentationCustomQueries struct {
 // ---
 // Configuration for the OpenTelemetry Batch Processor
 // https://pkg.go.dev/go.opentelemetry.io/collector/processor/batchprocessor#section-readme
-//
+// ---
 // The batch processor stops batching when *either* of these is zero, but that is confusing.
 // Make the user set both so it is evident there is *no* motivation to create any batch.
 // +kubebuilder:validation:XValidation:rule=`(has(self.minRecords) && self.minRecords == 0) == (has(self.maxDelay) && self.maxDelay == duration('0'))`,message=`to disable batching, both minRecords and maxDelay must be zero`