fix: envoy statistics config documentation (#12357)

* fix: envoy statistics config documentation

* chore: make gen

* feat: sync from istio/api

* Update content/zh/docs/ops/configuration/telemetry/envoy-stats/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>

Co-authored-by: Michael <haifeng.yao@daocloud.io>
This commit is contained in:
Alan Wang 2022-12-19 23:36:07 +08:00 committed by GitHub
parent a359a4aedf
commit a683dfac7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 32 additions and 26 deletions

View File

@ -49,7 +49,7 @@ If you build or maintain dashboards or alerts based on Envoy statistics, it is *
statistics in a canary environment **before upgrading Istio**.
{{< /tip >}}
To configure Istio proxy to record additional statistics, you can add [`ProxyConfig.ProxyStatsMatcher`](/docs/reference/config/istio.mesh.v1alpha1/#ProxyStatsMatcher) to your mesh config. For example, to enable stats for circuit breaker, retry, and upstream connections globally, you can specify stats matcher as follows:
To configure Istio proxy to record additional statistics, you can add [`ProxyConfig.ProxyStatsMatcher`](/docs/reference/config/istio.mesh.v1alpha1/#ProxyStatsMatcher) to your mesh config. For example, to enable stats for circuit breakers, request retries, upstream connections, and request timeouts globally, you can specify stats matcher as follows:
{{< tip >}}
Proxy needs to restart to pick up the stats matcher configuration.
@ -63,10 +63,11 @@ spec:
defaultConfig:
proxyStatsMatcher:
inclusionRegexps:
- ".*circuit_breakers.*"
inclusionPrefixes:
- "upstream_rq_retry"
- "upstream_cx"
- ".*outlier_detection.*"
- ".*upstream_rq_retry.*"
- ".*upstream_cx_.*"
inclusionSuffixes:
- "upstream_rq_timeout"
{{< /text >}}
You can also override the global stats matching configuration per proxy by using the `proxy.istio.io/config` annotation. For example, to configure the same stats generation inclusion as above, you can add the annotation to a gateway proxy or a workload as follows:
@ -77,10 +78,11 @@ metadata:
proxy.istio.io/config: |-
proxyStatsMatcher:
inclusionRegexps:
- ".*circuit_breakers.*"
inclusionPrefixes:
- "upstream_rq_retry"
- "upstream_cx"
- ".*outlier_detection.*"
- ".*upstream_rq_retry.*"
- ".*upstream_cx_.*"
inclusionSuffixes:
- "upstream_rq_timeout"
{{< /text >}}
{{< tip >}}

View File

@ -32,10 +32,11 @@ spec:
defaultConfig:
proxyStatsMatcher:
inclusionRegexps:
- ".*circuit_breakers.*"
inclusionPrefixes:
- "upstream_rq_retry"
- "upstream_cx"
- ".*outlier_detection.*"
- ".*upstream_rq_retry.*"
- ".*upstream_cx_.*"
inclusionSuffixes:
- "upstream_rq_timeout"
ENDSNIP
! read -r -d '' snip_proxyIstioConfig <<\ENDSNIP
@ -44,8 +45,9 @@ metadata:
proxy.istio.io/config: |-
proxyStatsMatcher:
inclusionRegexps:
- ".*circuit_breakers.*"
inclusionPrefixes:
- "upstream_rq_retry"
- "upstream_cx"
- ".*outlier_detection.*"
- ".*upstream_rq_retry.*"
- ".*upstream_cx_.*"
inclusionSuffixes:
- "upstream_rq_timeout"
ENDSNIP

View File

@ -45,7 +45,7 @@ Envoy 只收集在 `stats_matcher` JSON 字段中能匹配上 `inclusion_list`
如果您基于 Envoy 建立或者维护仪表盘或者告警,**强烈建议**您在**升级 Istio 之前**先在[金丝雀环境](/zh/docs/setup/upgrade/canary/index.md)检查统计信息。
{{< /tip >}}
想让 Istio 代理能够记录更多的统计信息,您可以在您的网格配置中添加 [`ProxyConfig.ProxyStatsMatcher`](/zh/docs/reference/config/istio.mesh.v1alpha1/#ProxyStatsMatcher)。例如,为了启用断路器、重试、全局上游连接的统计数据,您可以指定如下的数据统计的匹配配置:
想让 Istio 代理能够记录更多的统计信息,您可以在您的网格配置中添加 [`ProxyConfig.ProxyStatsMatcher`](/zh/docs/reference/config/istio.mesh.v1alpha1/#ProxyStatsMatcher)。例如,为了全局启用断路器、请求重试、上游连接和请求超时的统计数据,您可以指定如下的数据统计的匹配配置:
{{< tip >}}
为了能加载数据统计的匹配配置,代理需要重新启动。
@ -59,10 +59,11 @@ spec:
defaultConfig:
proxyStatsMatcher:
inclusionRegexps:
- ".*circuit_breakers.*"
inclusionPrefixes:
- "upstream_rq_retry"
- "upstream_cx"
- ".*outlier_detection.*"
- ".*upstream_rq_retry.*"
- ".*upstream_cx_.*"
inclusionSuffixes:
- "upstream_rq_timeout"
{{< /text >}}
通过使用每个代理的 `proxy.istio.io/config` 注解,您也可以重载全局数据统计对应的配置。
@ -74,10 +75,11 @@ metadata:
proxy.istio.io/config: |-
proxyStatsMatcher:
inclusionRegexps:
- ".*circuit_breakers.*"
inclusionPrefixes:
- "upstream_rq_retry"
- "upstream_cx"
- ".*outlier_detection.*"
- ".*upstream_rq_retry.*"
- ".*upstream_cx_.*"
inclusionSuffixes:
- "upstream_rq_timeout"
{{< /text >}}
{{< tip >}}