feat: use compression types for ProxyPrometheusProvider

Signed-off-by: zufardhiyaulhaq <zufardhiyaulhaq@gmail.com>
envoyproxy · Apr 15, 2024 · d26052a · d26052a
1 parent 11ecc75
commit d26052a
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 321 deletions.
diff --git a/api/v1alpha1/envoyproxy_metric_types.go b/api/v1alpha1/envoyproxy_metric_types.go
@@ -79,10 +79,7 @@ type ProxyOpenTelemetrySink struct {
 type ProxyPrometheusProvider struct {
 	// Disable the Prometheus endpoint.
 	Disable bool `json:"disable,omitempty"`
-	// Enable the compression on Prometheus endpoint.
-	EnableCompression bool `json:"enableCompression,omitempty"`
-	// Compression type
-	// +kubebuilder:validation:Enum=gzip;brotli;zstd
-	// +kubebuilder:default=gzip
-	CompressionLibrary string `json:"compressionLibrary,omitempty"`
+	// Configure the compression on Prometheus endpoint.
+	// +optional
+	Compression *Compression `json:"compression,omitempty"`
 }
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml
@@ -6227,20 +6227,24 @@ spec:
                         description: Prometheus defines the configuration for Admin
                           endpoint `/stats/prometheus`.
                         properties:
-                          compressionLibrary:
-                            default: gzip
-                            description: Compression type
-                            enum:
-                            - gzip
-                            - brotli
-                            - zstd
-                            type: string
+                          compression:
+                            description: Configure the compression on Prometheus endpoint.
+                            properties:
+                              gzip:
+                                description: The configuration for GZIP compressor.
+                                type: object
+                              type:
+                                description: CompressorType defines the compressor
+                                  type to use for compression.
+                                enum:
+                                - Gzip
+                                type: string
+                            required:
+                            - type
+                            type: object
                           disable:
                             description: Disable the Prometheus endpoint.
                             type: boolean
-                          enableCompression:
-                            description: Enable the compression on Prometheus endpoint.
-                            type: boolean
                         type: object
                       sinks:
                         description: Sinks defines the metric sinks where metrics

diff --git a/internal/xds/bootstrap/bootstrap.go b/internal/xds/bootstrap/bootstrap.go
@@ -153,10 +153,10 @@ func GetRenderedBootstrapConfig(opts *RenderBootsrapConfigOptions) (string, erro
 
 		if proxyMetrics.Prometheus != nil {
 			enablePrometheus = !proxyMetrics.Prometheus.Disable
-			enablePrometheusCompression = proxyMetrics.Prometheus.EnableCompression
 
-			if proxyMetrics.Prometheus.EnableCompression {
-				PrometheusCompressionLibrary = proxyMetrics.Prometheus.CompressionLibrary
+			if proxyMetrics.Prometheus.Compression != nil {
+				enablePrometheusCompression = true
+				PrometheusCompressionLibrary = string(proxyMetrics.Prometheus.Compression.Type)
 			}
 		}
 

diff --git a/internal/xds/bootstrap/bootstrap_test.go b/internal/xds/bootstrap/bootstrap_test.go
@@ -47,30 +47,9 @@ func TestGetRenderedBootstrapConfig(t *testing.T) {
 			opts: &RenderBootsrapConfigOptions{
 				ProxyMetrics: &egv1a1.ProxyMetrics{
 					Prometheus: &egv1a1.ProxyPrometheusProvider{
-						EnableCompression:  true,
-						CompressionLibrary: "gzip",
-					},
-				},
-			},
-		},
-		{
-			name: "enable-prometheus-brotli-compression",
-			opts: &RenderBootsrapConfigOptions{
-				ProxyMetrics: &egv1a1.ProxyMetrics{
-					Prometheus: &egv1a1.ProxyPrometheusProvider{
-						EnableCompression:  true,
-						CompressionLibrary: "brotli",
-					},
-				},
-			},
-		},
-		{
-			name: "enable-prometheus-zstd-compression",
-			opts: &RenderBootsrapConfigOptions{
-				ProxyMetrics: &egv1a1.ProxyMetrics{
-					Prometheus: &egv1a1.ProxyPrometheusProvider{
-						EnableCompression:  true,
-						CompressionLibrary: "zstd",
+						Compression: &egv1a1.Compression{
+							Type: "gzip",
+						},
 					},
 				},
 			},

diff --git a/internal/xds/bootstrap/testdata/render/enable-prometheus-brotli-compression.yaml b/internal/xds/bootstrap/testdata/render/enable-prometheus-brotli-compression.yaml
diff --git a/internal/xds/bootstrap/testdata/render/enable-prometheus-zstd-compression.yaml b/internal/xds/bootstrap/testdata/render/enable-prometheus-zstd-compression.yaml