From abf70e78dcdfc0e0f67fbac695b4b83281a81d1b Mon Sep 17 00:00:00 2001 From: Istio Automation Date: Thu, 26 Dec 2024 21:18:48 -0500 Subject: [PATCH] Automator: update istio.io@ reference docs (#16135) --- .../config/proxy_extensions/stats/index.html | 140 +++++++----------- .../config/proxy_extensions/stats/index.html | 140 +++++++----------- 2 files changed, 104 insertions(+), 176 deletions(-) diff --git a/content/en/docs/reference/config/proxy_extensions/stats/index.html b/content/en/docs/reference/config/proxy_extensions/stats/index.html index 15ddb4b48b..0246d13a84 100644 --- a/content/en/docs/reference/config/proxy_extensions/stats/index.html +++ b/content/en/docs/reference/config/proxy_extensions/stats/index.html @@ -22,69 +22,57 @@ path.

Field -Type Description -Required -dimensions -map<string, string> +
dimensions
+
map<string, string>
+

(Optional) Collection of tag names and tag expressions to include in the metric. Conflicts are resolved by the tag name by overriding previously supplied values.

- - -No -name -string +
name
+
string
+

(Optional) Metric name to restrict the override to a metric. If not specified, applies to all.

- - -No -tags_to_remove -string[] +
tags_to_remove
+
string[]
+

(Optional) A list of tags to remove.

- - -No -match -string +
match
+
string
+

NOT IMPLEMENTED. (Optional) Conditional enabling the override.

- - -No -drop -bool +
drop
+
bool
+

(Optional) If this is set to true, the metric(s) selected by this configuration will not be generated or reported.

- - -No @@ -96,43 +84,35 @@ No Field -Type Description -Required -name -string +
name
+
string
+

Metric name.

- - -No -value -string +
value
+
string
+

Metric value expression.

- - -No -type -MetricType +
type
+
MetricType
+

Metric type.

- - -No @@ -144,92 +124,76 @@ No Field -Type Description -Required -disable_host_header_fallback -bool +
disable_host_header_fallback
+
bool
+
-

Optional: Disable using host header as a fallback if destination service is +

Disable using host header as a fallback if destination service is not available from the controlplane. Disable the fallback if the host header originates outsides the mesh, like at ingress.

- - -No -tcp_reporting_duration -Duration +
tcp_reporting_duration
+
Duration
+
-

Optional. Allows configuration of the time between calls out to for TCP +

Allows configuration of the time between calls out to for TCP metrics reporting. The default duration is 5s.

- - -No -metrics -MetricConfig[] +
metrics
+
MetricConfig[]
+

Metric overrides.

- - -No -definitions -MetricDefinition[] +
definitions
+
MetricDefinition[]
+

Metric definitions.

- - -No -reporter -Reporter +
reporter
+
Reporter
+

Proxy deployment type.

- - -No -rotation_interval -Duration +
rotation_interval
+
Duration
+

Metric scope rotation interval. Set to 0 to disable the metric scope rotation. Defaults to 0.

- - -No -graceful_deletion_interval -Duration +
graceful_deletion_interval
+
Duration
+

Metric expiry graceful deletion interval. No-op if the metric rotation is disabled. Defaults to 5m. Must be >=1s.

- - -No @@ -246,17 +210,17 @@ No -COUNTER +COUNTER -GAUGE +GAUGE -HISTOGRAM +HISTOGRAM @@ -276,7 +240,7 @@ No -UNSPECIFIED +UNSPECIFIED

Default value is inferred from the listener direction, as either client or server sidecar.

@@ -284,7 +248,7 @@ server sidecar.

-SERVER_GATEWAY +SERVER_GATEWAY

Shared server gateway, e.g. “waypoint”.

diff --git a/content/zh/docs/reference/config/proxy_extensions/stats/index.html b/content/zh/docs/reference/config/proxy_extensions/stats/index.html index 15ddb4b48b..0246d13a84 100644 --- a/content/zh/docs/reference/config/proxy_extensions/stats/index.html +++ b/content/zh/docs/reference/config/proxy_extensions/stats/index.html @@ -22,69 +22,57 @@ path.

Field -Type Description -Required -dimensions -map<string, string> +
dimensions
+
map<string, string>
+

(Optional) Collection of tag names and tag expressions to include in the metric. Conflicts are resolved by the tag name by overriding previously supplied values.

- - -No -name -string +
name
+
string
+

(Optional) Metric name to restrict the override to a metric. If not specified, applies to all.

- - -No -tags_to_remove -string[] +
tags_to_remove
+
string[]
+

(Optional) A list of tags to remove.

- - -No -match -string +
match
+
string
+

NOT IMPLEMENTED. (Optional) Conditional enabling the override.

- - -No -drop -bool +
drop
+
bool
+

(Optional) If this is set to true, the metric(s) selected by this configuration will not be generated or reported.

- - -No @@ -96,43 +84,35 @@ No Field -Type Description -Required -name -string +
name
+
string
+

Metric name.

- - -No -value -string +
value
+
string
+

Metric value expression.

- - -No -type -MetricType +
type
+
MetricType
+

Metric type.

- - -No @@ -144,92 +124,76 @@ No Field -Type Description -Required -disable_host_header_fallback -bool +
disable_host_header_fallback
+
bool
+
-

Optional: Disable using host header as a fallback if destination service is +

Disable using host header as a fallback if destination service is not available from the controlplane. Disable the fallback if the host header originates outsides the mesh, like at ingress.

- - -No -tcp_reporting_duration -Duration +
tcp_reporting_duration
+
Duration
+
-

Optional. Allows configuration of the time between calls out to for TCP +

Allows configuration of the time between calls out to for TCP metrics reporting. The default duration is 5s.

- - -No -metrics -MetricConfig[] +
metrics
+
MetricConfig[]
+

Metric overrides.

- - -No -definitions -MetricDefinition[] +
definitions
+
MetricDefinition[]
+

Metric definitions.

- - -No -reporter -Reporter +
reporter
+
Reporter
+

Proxy deployment type.

- - -No -rotation_interval -Duration +
rotation_interval
+
Duration
+

Metric scope rotation interval. Set to 0 to disable the metric scope rotation. Defaults to 0.

- - -No -graceful_deletion_interval -Duration +
graceful_deletion_interval
+
Duration
+

Metric expiry graceful deletion interval. No-op if the metric rotation is disabled. Defaults to 5m. Must be >=1s.

- - -No @@ -246,17 +210,17 @@ No -COUNTER +COUNTER -GAUGE +GAUGE -HISTOGRAM +HISTOGRAM @@ -276,7 +240,7 @@ No -UNSPECIFIED +UNSPECIFIED

Default value is inferred from the listener direction, as either client or server sidecar.

@@ -284,7 +248,7 @@ server sidecar.

-SERVER_GATEWAY +SERVER_GATEWAY

Shared server gateway, e.g. “waypoint”.