Merge pull request #1765 from rancher/otel-fine-tuning

Allow fine tuning for the aggregator and daemon OTEL collectors

apis/core/v1beta1/collector_types.go

@@ -17,19 +17,132 @@ const (
 )
 
 type CollectorSpec struct {
-	opnimeta.ImageSpec `json:",inline,omitempty"`
-	AgentEndpoint      string                       `json:"agentEndpoint,omitempty"`
-	SystemNamespace    string                       `json:"systemNamespace,omitempty"`
-	LoggingConfig      *corev1.LocalObjectReference `json:"loggingConfig,omitempty"`
-	MetricsConfig      *corev1.LocalObjectReference `json:"metricsConfig,omitempty"`
-	ConfigReloader     *ConfigReloaderSpec          `json:"configReloader,omitempty"`
-	LogLevel           string                       `json:"logLevel,omitempty"`
+	opnimeta.ImageSpec       `json:",inline,omitempty"`
+	AgentEndpoint            string                       `json:"agentEndpoint,omitempty"`
+	SystemNamespace          string                       `json:"systemNamespace,omitempty"`
+	LoggingConfig            *corev1.LocalObjectReference `json:"loggingConfig,omitempty"`
+	MetricsConfig            *corev1.LocalObjectReference `json:"metricsConfig,omitempty"`
+	ConfigReloader           *ConfigReloaderSpec          `json:"configReloader,omitempty"`
+	LogLevel                 string                       `json:"logLevel,omitempty"`
+	AggregatorOTELConfigSpec *AggregatorOTELConfigSpec    `json:"aggregatorOtelCollectorSpec,omitempty"`
+	NodeOTELConfigSpec       *NodeOTELConfigSpec          `json:"nodeOtelCollectorSpec,omitempty"`
 }
 
 type ConfigReloaderSpec struct {
 	opnimeta.ImageSpec `json:",inline,omitempty"`
 }
 
+type AggregatorOTELConfigSpec struct {
+	Processors AggregatorOTELProcessors `json:"processors,omitempty"`
+	Exporters  AggregatorOTELExporters  `json:"exporters,omitempty"`
+}
+
+type AggregatorOTELProcessors struct {
+	Batch         BatchProcessorConfig         `json:"batch,omitempty"`
+	MemoryLimiter MemoryLimiterProcessorConfig `json:"memoryLimiter,omitempty"`
+}
+
+type AggregatorOTELExporters struct {
+	OTLPHTTP OTLPHTTPExporterConfig `json:"otlphttp,omitempty"`
+}
+
+type NodeOTELConfigSpec struct {
+	Processors NodeOTELProcessors `json:"processors,omitempty"`
+	Exporters  NodeOTELExporters  `json:"exporters,omitempty"`
+}
+
+type NodeOTELProcessors struct {
+	MemoryLimiter MemoryLimiterProcessorConfig `json:"memoryLimiter,omitempty"`
+}
+
+type NodeOTELExporters struct {
+	OTLP OTLPExporterConfig `json:"otlp,omitempty"`
+}
+
+// MemoryLimiterProcessorConfig has the attributes that we want to make
+// available from memorylimiterexporter.Config.
+// Also, we extend it with the JSON struct tags needed in order to kubebuilder
+// and controller-gen work.
+type MemoryLimiterProcessorConfig struct {
+	// CheckInterval is the time between measurements of memory usage for the
+	// purposes of avoiding going over the limits. Defaults to zero, so no
+	// checks will be performed.
+	// +kubebuilder:default:=1
+	CheckIntervalSeconds uint32 `json:"checkIntervalSeconds,omitempty"`
+
+	// MemoryLimitMiB is the maximum amount of memory, in MiB, targeted to be
+	// allocated by the process.
+	// +kubebuilder:default:=1000
+	MemoryLimitMiB uint32 `json:"limitMib,omitempty"`
+
+	// MemorySpikeLimitMiB is the maximum, in MiB, spike expected between the
+	// measurements of memory usage.
+	// +kubebuilder:default:=350
+	MemorySpikeLimitMiB uint32 `json:"spikeLimitMib,omitempty"`
+
+	// MemoryLimitPercentage is the maximum amount of memory, in %, targeted to be
+	// allocated by the process. The fixed memory settings MemoryLimitMiB has a higher precedence.
+	MemoryLimitPercentage uint32 `json:"limitPercentage,omitempty"`
+
+	// MemorySpikePercentage is the maximum, in percents against the total memory,
+	// spike expected between the measurements of memory usage.
+	MemorySpikePercentage uint32 `json:"spikeLimitPercentage,omitempty"`
+}
+
+// BatchProcessorConfig has the attributes that we want to make
+// available from batchprocessor.Config.
+// Also, we extend it with the JSON struct tags needed in order to kubebuilder
+// and controller-gen work.
+type BatchProcessorConfig struct {
+	// Timeout sets the time after which a batch will be sent regardless of size.
+	// When this is set to zero, batched data will be sent immediately.
+	// +kubebuilder:default:=15
+	TimeoutSeconds uint32 `json:"timeoutSeconds,omitempty"`
+
+	// SendBatchSize is the size of a batch which after hit, will trigger it to be sent.
+	// When this is set to zero, the batch size is ignored and data will be sent immediately
+	// subject to only send_batch_max_size.
+	// +kubebuilder:default:=1000
+	SendBatchSize uint32 `json:"sendBatchSize,omitempty"`
+
+	// SendBatchMaxSize is the maximum size of a batch. It must be larger than SendBatchSize.
+	// Larger batches are split into smaller units.
+	// Default value is 0, that means no maximum size.
+	SendBatchMaxSize uint32 `json:"sendBatchMaxSize,omitempty"`
+}
+
+// CollectorSendingQueue has the attributes that we want to make
+// available from exporterhelper.QueueSettings.
+// Also, we extend it with the JSON struct tags needed in order to kubebuilder
+// and controller-gen work.
+type CollectorSendingQueue struct {
+	// Enabled indicates whether to not enqueue batches before sending to the consumerSender.
+	// +kubebuilder:default:=true
+	Enabled bool `json:"enabled,omitempty"`
+	// NumConsumers is the number of consumers from the queue.
+	// +kubebuilder:default:=4
+	NumConsumers int `json:"numConsumers,omitempty"`
+	// QueueSize is the maximum number of batches allowed in queue at a given time.
+	// +kubebuilder:default:=100
+	QueueSize int `json:"queueSize,omitempty"`
+}
+
+// OTLPExporterConfig has the attributes that we want to make
+// available from otlpexporter.Config.
+// Also, we extend it with the JSON struct tags needed in order to kubebuilder
+// and controller-gen work.
+type OTLPExporterConfig struct {
+	SendingQueue CollectorSendingQueue `json:"sendingQueue,omitempty"`
+}
+
+// OTLPHTTPExporterConfig has the attributes that we want to make
+// available from otlphttpexporter.Config.
+// Also, we extend it with the JSON struct tags needed in order to kubebuilder
+// and controller-gen work.
+type OTLPHTTPExporterConfig struct {
+	SendingQueue CollectorSendingQueue `json:"sendingQueue,omitempty"`
+}
+
 // CollectorStatus defines the observed state of Collector
 type CollectorStatus struct {
 	Conditions []string       `json:"conditions,omitempty"`
@@ -73,6 +186,52 @@ func CollectorCRD() (*crd.CRD, error) {
 	}, nil
 }
 
+func NewDefaultAggregatorOTELConfigSpec() *AggregatorOTELConfigSpec {
+	return &AggregatorOTELConfigSpec{
+		Processors: AggregatorOTELProcessors{
+			MemoryLimiter: MemoryLimiterProcessorConfig{
+				MemoryLimitMiB:       1000,
+				MemorySpikeLimitMiB:  350,
+				CheckIntervalSeconds: 1,
+			},
+			Batch: BatchProcessorConfig{
+				SendBatchSize:  1000,
+				TimeoutSeconds: 15,
+			},
+		},
+		Exporters: AggregatorOTELExporters{
+			OTLPHTTP: OTLPHTTPExporterConfig{
+				SendingQueue: CollectorSendingQueue{
+					Enabled:      true,
+					NumConsumers: 4,
+					QueueSize:    100,
+				},
+			},
+		},
+	}
+}
+
+func NewDefaultNodeOTELConfigSpec() *NodeOTELConfigSpec {
+	return &NodeOTELConfigSpec{
+		Processors: NodeOTELProcessors{
+			MemoryLimiter: MemoryLimiterProcessorConfig{
+				MemoryLimitMiB:       250,
+				MemorySpikeLimitMiB:  50,
+				CheckIntervalSeconds: 1,
+			},
+		},
+		Exporters: NodeOTELExporters{
+			OTLP: OTLPExporterConfig{
+				SendingQueue: CollectorSendingQueue{
+					Enabled:      true,
+					NumConsumers: 4,
+					QueueSize:    100,
+				},
+			},
+		},
+	}
+}
+
 func init() {
 	SchemeBuilder.Register(&Collector{}, &CollectorList{})
 }