istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Automator: update istio.io@ reference docs (#16135)

This commit is contained in:
Istio Automation 2024-12-26 21:18:48 -05:00 committed by GitHub
parent e0c2809804
commit abf70e78dc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 104 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
content/en/docs/reference/config/proxy_extensions/stats/index.html
View File

@ -22,69 +22,57 @@ path.</p>
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th>Type</th>
<th>Description</th> <th>Description</th>
<th>Required</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr id="MetricConfig-dimensions"> <tr id="MetricConfig-dimensions">
<td><code>dimensions</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-dimensions">dimensions</a></code></div>
<td><code>map&lt;string,&nbsp;string&gt;</code></td> <div class="type">map&lt;string,&nbsp;string&gt;</div>
</div></td>
<td> <td>
<p>(Optional) Collection of tag names and tag expressions to include in the <p>(Optional) Collection of tag names and tag expressions to include in the
metric. Conflicts are resolved by the tag name by overriding previously metric. Conflicts are resolved by the tag name by overriding previously
supplied values.</p> supplied values.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-name"> <tr id="MetricConfig-name">
<td><code>name</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-name">name</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>(Optional) Metric name to restrict the override to a metric. If not <p>(Optional) Metric name to restrict the override to a metric. If not
specified, applies to all.</p> specified, applies to all.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-tags_to_remove"> <tr id="MetricConfig-tags_to_remove">
<td><code>tags_to_remove</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-tags_to_remove">tags_to_remove</a></code></div>
<td><code>string[]</code></td> <div class="type">string[]</div>
</div></td>
<td> <td>
<p>(Optional) A list of tags to remove.</p> <p>(Optional) A list of tags to remove.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-match"> <tr id="MetricConfig-match">
<td><code>match</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-match">match</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>NOT IMPLEMENTED. (Optional) Conditional enabling the override.</p> <p>NOT IMPLEMENTED. (Optional) Conditional enabling the override.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-drop"> <tr id="MetricConfig-drop">
<td><code>drop</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-drop">drop</a></code></div>
<td><code>bool</code></td> <div class="type">bool</div>
</div></td>
<td> <td>
<p>(Optional) If this is set to true, the metric(s) selected by this <p>(Optional) If this is set to true, the metric(s) selected by this
configuration will not be generated or reported.</p> configuration will not be generated or reported.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -96,43 +84,35 @@ No
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th>Type</th>
<th>Description</th> <th>Description</th>
<th>Required</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr id="MetricDefinition-name"> <tr id="MetricDefinition-name">
<td><code>name</code></td> <td><div class="field"><div class="name"><code><a href="#MetricDefinition-name">name</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>Metric name.</p> <p>Metric name.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricDefinition-value"> <tr id="MetricDefinition-value">
<td><code>value</code></td> <td><div class="field"><div class="name"><code><a href="#MetricDefinition-value">value</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>Metric value expression.</p> <p>Metric value expression.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricDefinition-type"> <tr id="MetricDefinition-type">
<td><code>type</code></td> <td><div class="field"><div class="name"><code><a href="#MetricDefinition-type">type</a></code></div>
<td><code><a href="#MetricType">MetricType</a></code></td> <div class="type"><a href="#MetricType">MetricType</a></div>
</div></td>
<td> <td>
<p>Metric type.</p> <p>Metric type.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -144,92 +124,76 @@ No
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th>Type</th>
<th>Description</th> <th>Description</th>
<th>Required</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr id="PluginConfig-disable_host_header_fallback"> <tr id="PluginConfig-disable_host_header_fallback">
<td><code>disable_host_header_fallback</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-disable_host_header_fallback">disable_host_header_fallback</a></code></div>
<td><code>bool</code></td> <div class="type">bool</div>
</div></td>
<td> <td>
<p>Optional: Disable using host header as a fallback if destination service is <p>Disable using host header as a fallback if destination service is
not available from the controlplane. Disable the fallback if the host not available from the controlplane. Disable the fallback if the host
header originates outsides the mesh, like at ingress.</p> header originates outsides the mesh, like at ingress.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-tcp_reporting_duration"> <tr id="PluginConfig-tcp_reporting_duration">
<td><code>tcp_reporting_duration</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-tcp_reporting_duration">tcp_reporting_duration</a></code></div>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td> <div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
</div></td>
<td> <td>
<p>Optional. Allows configuration of the time between calls out to for TCP <p>Allows configuration of the time between calls out to for TCP
metrics reporting. The default duration is <code>5s</code>.</p> metrics reporting. The default duration is <code>5s</code>.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-metrics"> <tr id="PluginConfig-metrics">
<td><code>metrics</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-metrics">metrics</a></code></div>
<td><code><a href="#MetricConfig">MetricConfig[]</a></code></td> <div class="type"><a href="#MetricConfig">MetricConfig[]</a></div>
</div></td>
<td> <td>
<p>Metric overrides.</p> <p>Metric overrides.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-definitions"> <tr id="PluginConfig-definitions">
<td><code>definitions</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-definitions">definitions</a></code></div>
<td><code><a href="#MetricDefinition">MetricDefinition[]</a></code></td> <div class="type"><a href="#MetricDefinition">MetricDefinition[]</a></div>
</div></td>
<td> <td>
<p>Metric definitions.</p> <p>Metric definitions.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-reporter"> <tr id="PluginConfig-reporter">
<td><code>reporter</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-reporter">reporter</a></code></div>
<td><code><a href="#Reporter">Reporter</a></code></td> <div class="type"><a href="#Reporter">Reporter</a></div>
</div></td>
<td> <td>
<p>Proxy deployment type.</p> <p>Proxy deployment type.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-rotation_interval"> <tr id="PluginConfig-rotation_interval">
<td><code>rotation_interval</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-rotation_interval">rotation_interval</a></code></div>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td> <div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
</div></td>
<td> <td>
<p>Metric scope rotation interval. Set to 0 to disable the metric scope rotation. <p>Metric scope rotation interval. Set to 0 to disable the metric scope rotation.
Defaults to 0.</p> Defaults to 0.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-graceful_deletion_interval"> <tr id="PluginConfig-graceful_deletion_interval">
<td><code>graceful_deletion_interval</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-graceful_deletion_interval">graceful_deletion_interval</a></code></div>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td> <div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
</div></td>
<td> <td>
<p>Metric expiry graceful deletion interval. No-op if the metric rotation is disabled. <p>Metric expiry graceful deletion interval. No-op if the metric rotation is disabled.
Defaults to 5m. Must be &gt;=1s.</p> Defaults to 5m. Must be &gt;=1s.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -246,17 +210,17 @@ No
</thead> </thead>
<tbody> <tbody>
<tr id="MetricType-COUNTER"> <tr id="MetricType-COUNTER">
<td><code>COUNTER</code></td> <td><code><a href="#MetricType-COUNTER">COUNTER</a></code></td>
<td> <td>
</td> </td>
</tr> </tr>
<tr id="MetricType-GAUGE"> <tr id="MetricType-GAUGE">
<td><code>GAUGE</code></td> <td><code><a href="#MetricType-GAUGE">GAUGE</a></code></td>
<td> <td>
</td> </td>
</tr> </tr>
<tr id="MetricType-HISTOGRAM"> <tr id="MetricType-HISTOGRAM">
<td><code>HISTOGRAM</code></td> <td><code><a href="#MetricType-HISTOGRAM">HISTOGRAM</a></code></td>
<td> <td>
</td> </td>
</tr> </tr>
@ -276,7 +240,7 @@ No
</thead> </thead>
<tbody> <tbody>
<tr id="Reporter-UNSPECIFIED"> <tr id="Reporter-UNSPECIFIED">
<td><code>UNSPECIFIED</code></td> <td><code><a href="#Reporter-UNSPECIFIED">UNSPECIFIED</a></code></td>
<td> <td>
<p>Default value is inferred from the listener direction, as either client or <p>Default value is inferred from the listener direction, as either client or
server sidecar.</p> server sidecar.</p>
@ -284,7 +248,7 @@ server sidecar.</p>
</td> </td>
</tr> </tr>
<tr id="Reporter-SERVER_GATEWAY"> <tr id="Reporter-SERVER_GATEWAY">
<td><code>SERVER_GATEWAY</code></td> <td><code><a href="#Reporter-SERVER_GATEWAY">SERVER_GATEWAY</a></code></td>
<td> <td>
<p>Shared server gateway, e.g. &ldquo;waypoint&rdquo;.</p> <p>Shared server gateway, e.g. &ldquo;waypoint&rdquo;.</p>

140
content/zh/docs/reference/config/proxy_extensions/stats/index.html
View File

@ -22,69 +22,57 @@ path.</p>
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th>Type</th>
<th>Description</th> <th>Description</th>
<th>Required</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr id="MetricConfig-dimensions"> <tr id="MetricConfig-dimensions">
<td><code>dimensions</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-dimensions">dimensions</a></code></div>
<td><code>map&lt;string,&nbsp;string&gt;</code></td> <div class="type">map&lt;string,&nbsp;string&gt;</div>
</div></td>
<td> <td>
<p>(Optional) Collection of tag names and tag expressions to include in the <p>(Optional) Collection of tag names and tag expressions to include in the
metric. Conflicts are resolved by the tag name by overriding previously metric. Conflicts are resolved by the tag name by overriding previously
supplied values.</p> supplied values.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-name"> <tr id="MetricConfig-name">
<td><code>name</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-name">name</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>(Optional) Metric name to restrict the override to a metric. If not <p>(Optional) Metric name to restrict the override to a metric. If not
specified, applies to all.</p> specified, applies to all.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-tags_to_remove"> <tr id="MetricConfig-tags_to_remove">
<td><code>tags_to_remove</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-tags_to_remove">tags_to_remove</a></code></div>
<td><code>string[]</code></td> <div class="type">string[]</div>
</div></td>
<td> <td>
<p>(Optional) A list of tags to remove.</p> <p>(Optional) A list of tags to remove.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-match"> <tr id="MetricConfig-match">
<td><code>match</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-match">match</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>NOT IMPLEMENTED. (Optional) Conditional enabling the override.</p> <p>NOT IMPLEMENTED. (Optional) Conditional enabling the override.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricConfig-drop"> <tr id="MetricConfig-drop">
<td><code>drop</code></td> <td><div class="field"><div class="name"><code><a href="#MetricConfig-drop">drop</a></code></div>
<td><code>bool</code></td> <div class="type">bool</div>
</div></td>
<td> <td>
<p>(Optional) If this is set to true, the metric(s) selected by this <p>(Optional) If this is set to true, the metric(s) selected by this
configuration will not be generated or reported.</p> configuration will not be generated or reported.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -96,43 +84,35 @@ No
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th>Type</th>
<th>Description</th> <th>Description</th>
<th>Required</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr id="MetricDefinition-name"> <tr id="MetricDefinition-name">
<td><code>name</code></td> <td><div class="field"><div class="name"><code><a href="#MetricDefinition-name">name</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>Metric name.</p> <p>Metric name.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricDefinition-value"> <tr id="MetricDefinition-value">
<td><code>value</code></td> <td><div class="field"><div class="name"><code><a href="#MetricDefinition-value">value</a></code></div>
<td><code>string</code></td> <div class="type">string</div>
</div></td>
<td> <td>
<p>Metric value expression.</p> <p>Metric value expression.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="MetricDefinition-type"> <tr id="MetricDefinition-type">
<td><code>type</code></td> <td><div class="field"><div class="name"><code><a href="#MetricDefinition-type">type</a></code></div>
<td><code><a href="#MetricType">MetricType</a></code></td> <div class="type"><a href="#MetricType">MetricType</a></div>
</div></td>
<td> <td>
<p>Metric type.</p> <p>Metric type.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -144,92 +124,76 @@ No
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th>Type</th>
<th>Description</th> <th>Description</th>
<th>Required</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr id="PluginConfig-disable_host_header_fallback"> <tr id="PluginConfig-disable_host_header_fallback">
<td><code>disable_host_header_fallback</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-disable_host_header_fallback">disable_host_header_fallback</a></code></div>
<td><code>bool</code></td> <div class="type">bool</div>
</div></td>
<td> <td>
<p>Optional: Disable using host header as a fallback if destination service is <p>Disable using host header as a fallback if destination service is
not available from the controlplane. Disable the fallback if the host not available from the controlplane. Disable the fallback if the host
header originates outsides the mesh, like at ingress.</p> header originates outsides the mesh, like at ingress.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-tcp_reporting_duration"> <tr id="PluginConfig-tcp_reporting_duration">
<td><code>tcp_reporting_duration</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-tcp_reporting_duration">tcp_reporting_duration</a></code></div>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td> <div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
</div></td>
<td> <td>
<p>Optional. Allows configuration of the time between calls out to for TCP <p>Allows configuration of the time between calls out to for TCP
metrics reporting. The default duration is <code>5s</code>.</p> metrics reporting. The default duration is <code>5s</code>.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-metrics"> <tr id="PluginConfig-metrics">
<td><code>metrics</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-metrics">metrics</a></code></div>
<td><code><a href="#MetricConfig">MetricConfig[]</a></code></td> <div class="type"><a href="#MetricConfig">MetricConfig[]</a></div>
</div></td>
<td> <td>
<p>Metric overrides.</p> <p>Metric overrides.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-definitions"> <tr id="PluginConfig-definitions">
<td><code>definitions</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-definitions">definitions</a></code></div>
<td><code><a href="#MetricDefinition">MetricDefinition[]</a></code></td> <div class="type"><a href="#MetricDefinition">MetricDefinition[]</a></div>
</div></td>
<td> <td>
<p>Metric definitions.</p> <p>Metric definitions.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-reporter"> <tr id="PluginConfig-reporter">
<td><code>reporter</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-reporter">reporter</a></code></div>
<td><code><a href="#Reporter">Reporter</a></code></td> <div class="type"><a href="#Reporter">Reporter</a></div>
</div></td>
<td> <td>
<p>Proxy deployment type.</p> <p>Proxy deployment type.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-rotation_interval"> <tr id="PluginConfig-rotation_interval">
<td><code>rotation_interval</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-rotation_interval">rotation_interval</a></code></div>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td> <div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
</div></td>
<td> <td>
<p>Metric scope rotation interval. Set to 0 to disable the metric scope rotation. <p>Metric scope rotation interval. Set to 0 to disable the metric scope rotation.
Defaults to 0.</p> Defaults to 0.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
<tr id="PluginConfig-graceful_deletion_interval"> <tr id="PluginConfig-graceful_deletion_interval">
<td><code>graceful_deletion_interval</code></td> <td><div class="field"><div class="name"><code><a href="#PluginConfig-graceful_deletion_interval">graceful_deletion_interval</a></code></div>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td> <div class="type"><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></div>
</div></td>
<td> <td>
<p>Metric expiry graceful deletion interval. No-op if the metric rotation is disabled. <p>Metric expiry graceful deletion interval. No-op if the metric rotation is disabled.
Defaults to 5m. Must be &gt;=1s.</p> Defaults to 5m. Must be &gt;=1s.</p>
</td>
<td>
No
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -246,17 +210,17 @@ No
</thead> </thead>
<tbody> <tbody>
<tr id="MetricType-COUNTER"> <tr id="MetricType-COUNTER">
<td><code>COUNTER</code></td> <td><code><a href="#MetricType-COUNTER">COUNTER</a></code></td>
<td> <td>
</td> </td>
</tr> </tr>
<tr id="MetricType-GAUGE"> <tr id="MetricType-GAUGE">
<td><code>GAUGE</code></td> <td><code><a href="#MetricType-GAUGE">GAUGE</a></code></td>
<td> <td>
</td> </td>
</tr> </tr>
<tr id="MetricType-HISTOGRAM"> <tr id="MetricType-HISTOGRAM">
<td><code>HISTOGRAM</code></td> <td><code><a href="#MetricType-HISTOGRAM">HISTOGRAM</a></code></td>
<td> <td>
</td> </td>
</tr> </tr>
@ -276,7 +240,7 @@ No
</thead> </thead>
<tbody> <tbody>
<tr id="Reporter-UNSPECIFIED"> <tr id="Reporter-UNSPECIFIED">
<td><code>UNSPECIFIED</code></td> <td><code><a href="#Reporter-UNSPECIFIED">UNSPECIFIED</a></code></td>
<td> <td>
<p>Default value is inferred from the listener direction, as either client or <p>Default value is inferred from the listener direction, as either client or
server sidecar.</p> server sidecar.</p>
@ -284,7 +248,7 @@ server sidecar.</p>
</td> </td>
</tr> </tr>
<tr id="Reporter-SERVER_GATEWAY"> <tr id="Reporter-SERVER_GATEWAY">
<td><code>SERVER_GATEWAY</code></td> <td><code><a href="#Reporter-SERVER_GATEWAY">SERVER_GATEWAY</a></code></td>
<td> <td>
<p>Shared server gateway, e.g. &ldquo;waypoint&rdquo;.</p> <p>Shared server gateway, e.g. &ldquo;waypoint&rdquo;.</p>