feat: add detailed description about compression

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

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/api/v1alpha1/envoyproxy_metric_types.go b/api/v1alpha1/envoyproxy_metric_types.go
@@ -79,7 +79,7 @@ type ProxyOpenTelemetrySink struct {
 type ProxyPrometheusProvider struct {
 	// Disable the Prometheus endpoint.
 	Disable bool `json:"disable,omitempty"`
-	// Configure the compression on Prometheus endpoint.
+	// Configure the compression on Prometheus endpoint. Compression is useful in situations when bandwidth is scarce and large payloads can be effectively compressed at the expense of higher CPU load.
 	// +optional
 	Compression *Compression `json:"compression,omitempty"`
 }
diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml
@@ -6229,6 +6229,9 @@ spec:
                         properties:
                           compression:
                             description: Configure the compression on Prometheus endpoint.
+                              Compression is useful in situations when bandwidth is
+                              scarce and large payloads can be effectively compressed
+                              at the expense of higher CPU load.
                             properties:
                               gzip:
                                 description: The configuration for GZIP compressor.

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md
@@ -2317,7 +2317,7 @@ _Appears in:_
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
 | `disable` | _boolean_ |  true  | Disable the Prometheus endpoint. |
-| `compression` | _[Compression](#compression)_ |  false  | Configure the compression on Prometheus endpoint. |
+| `compression` | _[Compression](#compression)_ |  false  | Configure the compression on Prometheus endpoint. Compression is useful in situations when bandwidth is scarce and large payloads can be effectively compressed at the expense of higher CPU load. |
 
 
 #### ProxyProtocol