Skip to content

Commit fe4fd4b

Browse files
zirainzirain
authored
docs: improve doc for ClusterStatName (#7609)
* docs: improve doc for ClusterStatName Signed-off-by: zirain <[email protected]>
1 parent f6dfa51 commit fe4fd4b

File tree

6 files changed

+41
-41
lines changed

6 files changed

+41
-41
lines changed

‎api/v1alpha1/envoyproxy_metric_types.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ type ProxyMetrics struct {
4545
// ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.
4646
// For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html
4747
// The supported operators for this pattern are:
48-
// %ROUTE_NAME%: name of Gateway API xRoute resource
49-
// %ROUTE_NAMESPACE%: namespace of Gateway API xRoute resource
50-
// %ROUTE_KIND%: kind of Gateway API xRoute resource
51-
// %ROUTE_RULE_NAME%: name of the Gateway API xRoute section
52-
// %ROUTE_RULE_NUMBER%: name of the Gateway API xRoute section
53-
// %BACKEND_REFS%: names of all backends referenced in <NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|... format
48+
// `%ROUTE_NAME%`: name of Gateway API xRoute resource
49+
// `%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource
50+
// `%ROUTE_KIND%`: kind of Gateway API xRoute resource
51+
// `%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section
52+
// `%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section
53+
// `%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|...` format
5454
// Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.
55-
// Default: %ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%
56-
// Example: httproute/my-ns/my-route/rule/0
55+
// Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%`
56+
// Example: `httproute/my-ns/my-route/rule/0`
5757
//
5858
// +optional
5959
ClusterStatName *string `json:"clusterStatName,omitempty"`

‎charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_envoyproxies.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13470,15 +13470,15 @@ spec:
1347013470
ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.
1347113471
For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html
1347213472
The supported operators for this pattern are:
13473-
%ROUTE_NAME%: name of Gateway API xRoute resource
13474-
%ROUTE_NAMESPACE%: namespace of Gateway API xRoute resource
13475-
%ROUTE_KIND%: kind of Gateway API xRoute resource
13476-
%ROUTE_RULE_NAME%: name of the Gateway API xRoute section
13477-
%ROUTE_RULE_NUMBER%: name of the Gateway API xRoute section
13478-
%BACKEND_REFS%: names of all backends referenced in <NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|... format
13473+
`%ROUTE_NAME%`: name of Gateway API xRoute resource
13474+
`%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource
13475+
`%ROUTE_KIND%`: kind of Gateway API xRoute resource
13476+
`%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section
13477+
`%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section
13478+
`%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|...` format
1347913479
Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.
13480-
Default: %ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%
13481-
Example: httproute/my-ns/my-route/rule/0
13480+
Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%`
13481+
Example: `httproute/my-ns/my-route/rule/0`
1348213482
type: string
1348313483
enablePerEndpointStats:
1348413484
description: |-

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13469,15 +13469,15 @@ spec:
1346913469
ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.
1347013470
For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html
1347113471
The supported operators for this pattern are:
13472-
%ROUTE_NAME%: name of Gateway API xRoute resource
13473-
%ROUTE_NAMESPACE%: namespace of Gateway API xRoute resource
13474-
%ROUTE_KIND%: kind of Gateway API xRoute resource
13475-
%ROUTE_RULE_NAME%: name of the Gateway API xRoute section
13476-
%ROUTE_RULE_NUMBER%: name of the Gateway API xRoute section
13477-
%BACKEND_REFS%: names of all backends referenced in <NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|... format
13472+
`%ROUTE_NAME%`: name of Gateway API xRoute resource
13473+
`%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource
13474+
`%ROUTE_KIND%`: kind of Gateway API xRoute resource
13475+
`%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section
13476+
`%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section
13477+
`%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|...` format
1347813478
Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.
13479-
Default: %ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%
13480-
Example: httproute/my-ns/my-route/rule/0
13479+
Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%`
13480+
Example: `httproute/my-ns/my-route/rule/0`
1348113481
type: string
1348213482
enablePerEndpointStats:
1348313483
description: |-

‎site/content/en/latest/api/extension_types.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4029,7 +4029,7 @@ _Appears in:_
40294029
| `enableVirtualHostStats` | _boolean_ | false | | EnableVirtualHostStats enables envoy stat metrics for virtual hosts. |
40304030
| `enablePerEndpointStats` | _boolean_ | false | | EnablePerEndpointStats enables per endpoint envoy stats metrics.<br />Please use with caution. |
40314031
| `enableRequestResponseSizesStats` | _boolean_ | false | | EnableRequestResponseSizesStats enables publishing of histograms tracking header and body sizes of requests and responses. |
4032-
| `clusterStatName` | _string_ | false | | ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.<br />For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html<br />The supported operators for this pattern are:<br />%ROUTE_NAME%: name of Gateway API xRoute resource<br />%ROUTE_NAMESPACE%: namespace of Gateway API xRoute resource<br />%ROUTE_KIND%: kind of Gateway API xRoute resource<br />%ROUTE_RULE_NAME%: name of the Gateway API xRoute section<br />%ROUTE_RULE_NUMBER%: name of the Gateway API xRoute section<br />%BACKEND_REFS%: names of all backends referenced in <NAMESPACE>/<NAME>\|<NAMESPACE>/<NAME>\|... format<br />Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.<br />Default: %ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%<br />Example: httproute/my-ns/my-route/rule/0 |
4032+
| `clusterStatName` | _string_ | false | | ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.<br />For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html<br />The supported operators for this pattern are:<br />`%ROUTE_NAME%`: name of Gateway API xRoute resource<br />`%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource<br />`%ROUTE_KIND%`: kind of Gateway API xRoute resource<br />`%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section<br />`%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section<br />`%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>\|<NAMESPACE>/<NAME>\|...` format<br />Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.<br />Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%`<br />Example: `httproute/my-ns/my-route/rule/0` |
40334033

40344034

40354035
#### ProxyOpenTelemetrySink

‎test/helm/gateway-crds-helm/all.out.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41764,15 +41764,15 @@ spec:
4176441764
ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.
4176541765
For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html
4176641766
The supported operators for this pattern are:
41767-
%ROUTE_NAME%: name of Gateway API xRoute resource
41768-
%ROUTE_NAMESPACE%: namespace of Gateway API xRoute resource
41769-
%ROUTE_KIND%: kind of Gateway API xRoute resource
41770-
%ROUTE_RULE_NAME%: name of the Gateway API xRoute section
41771-
%ROUTE_RULE_NUMBER%: name of the Gateway API xRoute section
41772-
%BACKEND_REFS%: names of all backends referenced in <NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|... format
41767+
`%ROUTE_NAME%`: name of Gateway API xRoute resource
41768+
`%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource
41769+
`%ROUTE_KIND%`: kind of Gateway API xRoute resource
41770+
`%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section
41771+
`%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section
41772+
`%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|...` format
4177341773
Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.
41774-
Default: %ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%
41775-
Example: httproute/my-ns/my-route/rule/0
41774+
Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%`
41775+
Example: `httproute/my-ns/my-route/rule/0`
4177641776
type: string
4177741777
enablePerEndpointStats:
4177841778
description: |-

‎test/helm/gateway-crds-helm/envoy-gateway-crds.out.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21108,15 +21108,15 @@ spec:
2110821108
ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named.
2110921109
For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html
2111021110
The supported operators for this pattern are:
21111-
%ROUTE_NAME%: name of Gateway API xRoute resource
21112-
%ROUTE_NAMESPACE%: namespace of Gateway API xRoute resource
21113-
%ROUTE_KIND%: kind of Gateway API xRoute resource
21114-
%ROUTE_RULE_NAME%: name of the Gateway API xRoute section
21115-
%ROUTE_RULE_NUMBER%: name of the Gateway API xRoute section
21116-
%BACKEND_REFS%: names of all backends referenced in <NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|... format
21111+
`%ROUTE_NAME%`: name of Gateway API xRoute resource
21112+
`%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource
21113+
`%ROUTE_KIND%`: kind of Gateway API xRoute resource
21114+
`%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section
21115+
`%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section
21116+
`%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|...` format
2111721117
Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported.
21118-
Default: %ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%
21119-
Example: httproute/my-ns/my-route/rule/0
21118+
Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%`
21119+
Example: `httproute/my-ns/my-route/rule/0`
2112021120
type: string
2112121121
enablePerEndpointStats:
2112221122
description: |-

0 commit comments

Comments
 (0)