api: add stats_matcher for envoy's stats

api/config/v1alpha1/metric_types.go

@@ -10,6 +10,14 @@ type ProxyMetrics struct {
 	Prometheus *PrometheusProvider `json:"prometheus,omitempty"`
 	// Sinks defines the metric sinks where metrics are sent to.
 	Sinks []MetricSink `json:"sinks,omitempty"`
+	// Matches defines configuration for metric matching rules
+	// to reduce memory and CPU overhead from Envoy stats system.
+	// When Matches is nil(not set), gateway by default create and expose only a subset of
+	// Envoy stats with prefixes(cluster_manager,listener_manager,server,cluster.xds-grpc)
+	// expressions match on the name of stats.
+	// When Matches is not empty, this option is to control creation of additional Envoy stats
+	// with prefix, suffix, and regex expressions match on the name of the stats.
+	Matches []Match `json:"matches,omitempty"`
 }
 
 type MetricSinkType string
@@ -29,6 +37,19 @@ type MetricSink struct {
 	OpenTelemetry *OpenTelemetrySink `json:"openTelemetry,omitempty"`
 }
 
+type Match struct {
+	Type  MatcherType `json:"type"`
+	Value string      `json:"value"`
+}
+
+type MatcherType string
+
+const (
+	Prefix MatcherType = "Prefix"
+	Regex  MatcherType = "Regex"
+	Suffix MatcherType = "Suffix"
+)
+
 type OpenTelemetrySink struct {
 	// Host define the service hostname.
 	Host string `json:"host"`

charts/gateway-helm/crds/generated/config.gateway.envoyproxy.io_envoyproxies.yaml

@@ -3926,6 +3926,26 @@ spec:
                     description: Metrics defines metrics configuration for managed
                       proxies.
                     properties:
+                      matches:
+                        description: Matches defines configuration for metric matching
+                          rules to reduce memory and CPU overhead from Envoy stats
+                          system. When Matches is nil(not set), gateway by default
+                          create and expose only a subset of Envoy stats with prefixes(cluster_manager,listener_manager,server,cluster.xds-grpc)
+                          expressions match on the name of stats. When Matches is
+                          not empty, this option is to control creation of additional
+                          Envoy stats with prefix, suffix, and regex expressions match
+                          on the name of the stats.
+                        items:
+                          properties:
+                            type:
+                              type: string
+                            value:
+                              type: string
+                          required:
+                          - type
+                          - value
+                          type: object
+                        type: array
                       prometheus:
                         description: Prometheus defines the configuration for Admin
                           endpoint `/stats/prometheus`.

docs/latest/api/config_types.md

@@ -592,6 +592,32 @@ _Appears in:_
 
 
 
+## Match
+
+
+
+
+
+_Appears in:_
+- [ProxyMetrics](#proxymetrics)
+
+| Field | Description |
+| --- | --- |
+| `type` _[MatcherType](#matchertype)_ |  |
+| `value` _string_ |  |
+
+
+## MatcherType
+
+_Underlying type:_ `string`
+
+
+
+_Appears in:_
+- [Match](#match)
+
+
+
 ## MetricSink
 
 
@@ -783,6 +809,7 @@ _Appears in:_
 | --- | --- |
 | `prometheus` _[PrometheusProvider](#prometheusprovider)_ | Prometheus defines the configuration for Admin endpoint `/stats/prometheus`. |
 | `sinks` _[MetricSink](#metricsink) array_ | Sinks defines the metric sinks where metrics are sent to. |
+| `matches` _[Match](#match) array_ | Matches defines configuration for metric matching rules to reduce memory and CPU overhead from Envoy stats system. When Matches is nil(not set), gateway by default create and expose only a subset of Envoy stats with prefixes(cluster_manager,listener_manager,server,cluster.xds-grpc) expressions match on the name of stats. When Matches is not empty, this option is to control creation of additional Envoy stats with prefix, suffix, and regex expressions match on the name of the stats. |
 
 
 ## ProxyTelemetry