From 42b3b87c57df9b8e0e78c7c238d73b3cb9373d0a Mon Sep 17 00:00:00 2001 From: Istio Automation Date: Fri, 18 Mar 2022 19:50:43 -0700 Subject: [PATCH] Automator: update istio.io@ reference docs (#11077) --- .../reference/config/telemetry/index.html | 206 +++++++++++++----- 1 file changed, 156 insertions(+), 50 deletions(-) diff --git a/content/en/docs/reference/config/telemetry/index.html b/content/en/docs/reference/config/telemetry/index.html index 83e0286569..69573cb6c1 100644 --- a/content/en/docs/reference/config/telemetry/index.html +++ b/content/en/docs/reference/config/telemetry/index.html @@ -8,18 +8,18 @@ layout: protoc-gen-docs generator: protoc-gen-docs schema: istio.telemetry.v1alpha1.Telemetry aliases: [/docs/reference/config/telemetry/v1alpha1/telemetry] -number_of_entries: 16 +number_of_entries: 18 ---

Telemetry defines how the telemetry is generated for workloads within a mesh.

-

For mesh level configuration, put the resource in root configuration namespace for -your Istio installation without a workload selector.

+

For mesh level configuration, put the resource in root configuration +namespace for your Istio installation without a workload selector.

-

For any namespace, including the root configuration namespace, it is only valid -to have a single workload selector-less Telemetry resource.

+

For any namespace, including the root configuration namespace, it is only +valid to have a single workload selector-less Telemetry resource.

-

For resources with a workload selector, it is only valid to have one resource selecting -any given workload.

+

For resources with a workload selector, it is only valid to have one resource +selecting any given workload.

The hierarchy of Telemetry configuration is as follows:

@@ -184,10 +184,11 @@ spec: accessLogging: - providers: - name: envoy - # By default, this turns on access logging (no need to set `disabled: false`). - # Unspecified `disabled` will be treated as `disabled: false`, except in - # cases where a parent configuration has marked as `disabled: true`. In - # those cases, `disabled: false` must be set explicitly to override. + # By default, this turns on access logging (no need to set `disabled: + false`). # Unspecified `disabled` will be treated as `disabled: false`, + except in # cases where a parent configuration has marked as `disabled: + true`. In # those cases, `disabled: false` must be set explicitly to + override.

Policy to disable access logging for the foo namespace:

@@ -290,15 +291,26 @@ fully replace any values provided by parent configuration.

+ +match +TracingSelector + +

Allows tailoring of behavior to specific conditions.

+ + + +No + + providers ProviderRef[]

Optional. Name of provider(s) to use for span reporting. If a provider is -not specified, the default tracing provider -will be used. -NOTE: At the moment, only a single provider can be specified in a given -Tracing rule.

+not specified, the [default tracing +provider][istio.mesh.v1alpha1.MeshConfig.default_providers.tracing] will be +used. NOTE: At the moment, only a single provider can be specified in a +given Tracing rule.

@@ -310,11 +322,11 @@ No DoubleValue

Controls the rate at which traffic will be selected for tracing if no -prior sampling decision has been made. If a prior sampling decision has been -made, that decision will be respected. However, if no sampling decision -has been made (example: no x-b3-sampled tracing header was present in the -requests), the traffic will be selected for telemetry generation at the -percentage specified.

+prior sampling decision has been made. If a prior sampling decision has +been made, that decision will be respected. However, if no sampling +decision has been made (example: no x-b3-sampled tracing header was +present in the requests), the traffic will be selected for telemetry +generation at the percentage specified.

Defaults to 0%. Valid values [0.00-100.00]. Can be specified in 0.01% increments.

@@ -401,8 +413,9 @@ as to customize the dimensions of the generated metrics.

ProviderRef[]

Optional. Name of providers to which this configuration should apply. -If a provider is not specified, the default metrics provider -will be used.

+If a provider is not specified, the [default metrics +provider][istio.mesh.v1alpha1.MeshConfig.default_providers.metrics] will be +used.

@@ -465,8 +478,8 @@ No customMetric string (oneof) -

Allows free-form specification of a metric. No validation of custom metrics -is provided.

+

Allows free-form specification of a metric. No validation of custom +metrics is provided.

@@ -477,7 +490,8 @@ No mode WorkloadMode -

Controls which mode of metrics generation is selected: CLIENT and/or SERVER.

+

Controls which mode of metrics generation is selected: CLIENT and/or +SERVER.

@@ -553,8 +567,9 @@ No

AccessLogging

-

Access logging defines the workload-level overrides for access log generation. -It can be used to select provider or enable/disable access log generation for a workload.

+

Access logging defines the workload-level overrides for access log +generation. It can be used to select provider or enable/disable access log +generation for a workload.

@@ -566,13 +581,24 @@ It can be used to select provider or enable/disable access log generation for a + + + + + + + + + +
matchLogSelector +

Allows tailoring of logging behavior to specific conditions.

+ +		 +No +
providers ProviderRef[]

Optional. Name of providers to which this configuration should apply. -If a provider is not specified, the default logging provider -will be used.

+If a provider is not specified, the [default logging +provider][istio.mesh.v1alpha1.MeshConfig.default_providers.] will be used.

 @@ -601,6 +627,36 @@ No

Optional. If specified, this filter will be used to select specific requests/connections for logging.

+		 +No +
+
+

Tracing.TracingSelector

+
+

TracingSelector provides a coarse-grained ability to configure tracing +behavior based on certain traffic metadata (such as traffic direction).

+ + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
modeWorkloadMode +

This determines whether or not to apply the tracing configuration +based on the direction of traffic relative to the proxied workload.

+ 		No @@ -655,7 +711,8 @@ No header RequestHeader (oneof) -

RequestHeader adds the value of an header from the request to each span.

+

RequestHeader adds the value of an header from the request to each +span.

 @@ -799,11 +856,47 @@ No string

Value is only considered if the operation is UPSERT. -Values are CEL expressions over attributes. -Examples include: “string(destination.port)” and “request.host”. -Istio exposes all standard Envoy attributes. +Values are CEL expressions over +attributes. Examples include: “string(destination.port)” and +“request.host”. Istio exposes all standard Envoy +attributes. Additionally, Istio exposes node metadata as attributes. -More information is provided in the customization docs.

+More information is provided in the customization +docs.

+ +		 +No +
+
+

AccessLogging.LogSelector

+
+

LogSelector provides a coarse-grained ability to configure logging behavior +based on certain traffic metadata (such as traffic direction). LogSelector +applies to traffic metadata which is not represented in the attribute set +currently supported by Filters. It allows control planes to limit the +configuration sent to individual workloads. Finer-grained logging behavior +can be further configured via filter.

+ + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
modeWorkloadMode +

This determines whether or not to apply the access logging configuration +based on the direction of traffic relative to the proxied workload.

 @@ -850,8 +943,9 @@ No

MetricSelector.IstioMetric

-

Curated list of known metric types that is supported by Istio metric providers. -See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

+

Curated list of known metric types that is supported by Istio metric +providers. See also: +https://istio.io/latest/docs/reference/config/metrics/#metrics

@@ -864,14 +958,16 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

@@ -1010,7 +1115,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

@@ -1030,8 +1136,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

ALL_METRICS -

Use of this enum indicates that the override should apply to all Istio default metrics.

+

Use of this enum indicates that the override should apply to all Istio +default metrics.
REQUEST_COUNT -

Counter of requests to/from an application, generated for HTTP, HTTP/2, and GRPC traffic.

+

Counter of requests to/from an application, generated for HTTP, HTTP/2, +and GRPC traffic.

The Prometheus provider exports this metric as: istio_requests_total.

@@ -887,9 +983,11 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

REQUEST_DURATION -

Histogram of request durations, generated for HTTP, HTTP/2, and GRPC traffic.

+

Histogram of request durations, generated for HTTP, HTTP/2, and GRPC +traffic.

-

The Prometheus provider exports this metric as: istio_request_duration_milliseconds.

+

The Prometheus provider exports this metric as: +istio_request_duration_milliseconds.

The Stackdriver provider exports this metric as:

@@ -903,7 +1001,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

REQUEST_SIZE -

Histogram of request body sizes, generated for HTTP, HTTP/2, and GRPC traffic.

+

Histogram of request body sizes, generated for HTTP, HTTP/2, and GRPC +traffic.

The Prometheus provider exports this metric as: istio_request_bytes.

@@ -919,7 +1018,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

RESPONSE_SIZE -

Histogram of response body sizes, generated for HTTP, HTTP/2, and GRPC traffic.

+

Histogram of response body sizes, generated for HTTP, HTTP/2, and GRPC +traffic.

The Prometheus provider exports this metric as: istio_response_bytes.

@@ -937,7 +1037,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

Counter of TCP connections opened over lifetime of workload.

-

The Prometheus provider exports this metric as: istio_tcp_connections_opened_total.

+

The Prometheus provider exports this metric as: +istio_tcp_connections_opened_total.

The Stackdriver provider exports this metric as:

@@ -953,7 +1054,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

Counter of TCP connections closed over lifetime of workload.

-

The Prometheus provider exports this metric as: istio_tcp_connections_closed_total.

+

The Prometheus provider exports this metric as: +istio_tcp_connections_closed_total.

The Stackdriver provider exports this metric as:

@@ -969,7 +1071,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

Counter of bytes sent during a response over a TCP connection.

-

The Prometheus provider exports this metric as: istio_tcp_sent_bytes_total.

+

The Prometheus provider exports this metric as: +istio_tcp_sent_bytes_total.

The Stackdriver provider exports this metric as:

@@ -985,7 +1088,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

Counter of bytes received during a request over a TCP connection.

-

The Prometheus provider exports this metric as: istio_tcp_received_bytes_total.

+

The Prometheus provider exports this metric as: +istio_tcp_received_bytes_total.

The Stackdriver provider exports this metric as:

@@ -1001,7 +1105,8 @@ See also: https://istio.io/latest/docs/reference/config/metrics/#metrics

Counter incremented for every gRPC messages sent from a client.

-

The Prometheus provider exports this metric as: istio_request_messages_total

+

The Prometheus provider exports this metric as: +istio_request_messages_total

Counter incremented for every gRPC messages sent from a server.

-

The Prometheus provider exports this metric as: istio_response_messages_total

+

The Prometheus provider exports this metric as: +istio_response_messages_total
UPSERT -

Insert or Update the tag with the provided value expression. The value -field MUST be specified if UPSERT is used as the operation.

+

Insert or Update the tag with the provided value expression. The +value field MUST be specified if UPSERT is used as the operation.