mirror of https://github.com/istio/istio.io.git
Documentation fixes for Metrics Classification example (#9277)
* Documentation fixes for Metrics Classification example * Update for 1.9 * Fix yaml indenting to prevent kubectl apply error * Fix typo * use version shortcode for dynamic version, more clarifaction on examples * fix indenting * fix linting errors
This commit is contained in:
Roland Kool
GitHub
parent
13221efdbf
commit
593e85fb66
|
|
@ -35,7 +35,7 @@ For more information, see the
|
|||
|
||||
Istio uses the Envoy proxy to generate metrics and provides its configuration in
|
||||
the `EnvoyFilter` at
|
||||
[`manifests/charts/istio-control/istio-discovery/templates/telemetryv2_1.8.yaml`]({{<github_blob>}}/manifests/charts/istio-control/istio-discovery/templates/telemetryv2_1.8.yaml).
|
||||
[`manifests/charts/istio-control/istio-discovery/templates/telemetryv2_{{< istio_version >}}.yaml`]({{<github_blob>}}/manifests/charts/istio-control/istio-discovery/templates/telemetryv2_{{< istio_version >}}.yaml).
|
||||
As a result, writing classification rules involves adding attributes to the
|
||||
`EnvoyFilter`.
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ spec:
|
|||
match:
|
||||
context: SIDECAR_INBOUND
|
||||
proxy:
|
||||
proxyVersion: '1\.8.*'
|
||||
proxyVersion: '1\.9.*'
|
||||
listener:
|
||||
filterChain:
|
||||
filter:
|
||||
|
|
@ -118,22 +118,22 @@ spec:
|
|||
$ kubectl -n istio-system apply -f attribute_gen_service.yaml
|
||||
{{< /text >}}
|
||||
|
||||
1. Find the `stats-filter-1.8` `EnvoyFilter` resource from the `istio-system`
|
||||
1. Find the `stats-filter-{{< istio_version >}}` `EnvoyFilter` resource from the `istio-system`
|
||||
namespace, using the following command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ kubectl -n istio-system get envoyfilter | grep ^stats-filter-1.8
|
||||
stats-filter-1.8 2d
|
||||
$ kubectl -n istio-system get envoyfilter | grep ^stats-filter-{{< istio_version >}}
|
||||
stats-filter-{{< istio_version >}} 2d
|
||||
{{< /text >}}
|
||||
|
||||
1. Create a local file system copy of the `EnvoyFilter` configuration, using the
|
||||
following command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ kubectl -n istio-system get envoyfilter stats-filter-1.8 -o yaml > stats-filter-1.8.yaml
|
||||
$ kubectl -n istio-system get envoyfilter stats-filter-{{< istio_version >}} -o yaml > stats-filter-{{< istio_version >}}.yaml
|
||||
{{< /text >}}
|
||||
|
||||
1. Open `stats-filter-1.8.yaml` with a text editor and locate the
|
||||
1. Open `stats-filter-{{< istio_version >}}.yaml` with a text editor and locate the
|
||||
`name: istio.stats` extension configuration. Update it to map `request_operation`
|
||||
dimension in the `requests_total` standard metric to `istio_operationId` attribute.
|
||||
The updated configuration file section should look like the following.
|
||||
|
|
@ -148,21 +148,32 @@ spec:
|
|||
configuration:
|
||||
"@type": type.googleapis.com/google.protobuf.StringValue
|
||||
value: |
|
||||
{
|
||||
"metrics": [
|
||||
{
|
||||
"name": "requests_total",
|
||||
"dimensions": {
|
||||
"request_operation": "istio_operationId"
|
||||
}
|
||||
}]
|
||||
}
|
||||
{
|
||||
"metrics": [
|
||||
{
|
||||
"name": "requests_total",
|
||||
"dimensions": {
|
||||
"request_operation": "istio_operationId"
|
||||
}
|
||||
}]
|
||||
}
|
||||
{{< /text >}}
|
||||
|
||||
1. Save `stats-filter-1.8.yaml` and then apply the configuration using the following command:
|
||||
1. Save `stats-filter-{{< istio_version >}}.yaml` and then apply the configuration using the following command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ kubectl -n istio-system apply -f stats-filter-1.8.yaml
|
||||
$ kubectl -n istio-system apply -f stats-filter-{{< istio_version >}}.yaml
|
||||
{{< /text >}}
|
||||
|
||||
1. Add the following configuration to the mesh config. This results in the addition of the `request_operation` as a
|
||||
new dimension to the `istio_requests_total` metric. Without it, a new metric with the name `envoy_request_operation___somevalue___istio_requests_total`
|
||||
is created.
|
||||
|
||||
{{< text yaml >}}
|
||||
meshConfig:
|
||||
defaultConfig:
|
||||
extraStatTags:
|
||||
- request_operation
|
||||
{{< /text >}}
|
||||
|
||||
1. Generate metrics by sending traffic to your application.
|
||||
|
|
@ -172,10 +183,11 @@ spec:
|
|||
|
||||
## Classify metrics by response
|
||||
|
||||
You can classify responses using a similar process as requests.
|
||||
You can classify responses using a similar process as requests. Do note that the `response_code` dimension already exists by default.
|
||||
The example below will change how it is populated.
|
||||
|
||||
1. Create a file, for example `attribute_gen_service.yaml`, and save it with the
|
||||
following contents. This add the `istio.attributegen` plugin to the
|
||||
following contents. This adds the `istio.attributegen` plugin to the
|
||||
`EnvoyFilter` and generates the `istio_responseClass` attribute used by the
|
||||
stats plugin.
|
||||
|
||||
|
|
@ -196,7 +208,7 @@ spec:
|
|||
match:
|
||||
context: SIDECAR_INBOUND
|
||||
proxy:
|
||||
proxyVersion: '1\.8.*'
|
||||
proxyVersion: '1\.9.*'
|
||||
listener:
|
||||
filterChain:
|
||||
filter:
|
||||
|
|
@ -215,43 +227,43 @@ spec:
|
|||
configuration:
|
||||
"@type": type.googleapis.com/google.protobuf.StringValue
|
||||
value: |
|
||||
{
|
||||
"attributes": [
|
||||
{
|
||||
"output_attribute": "istio_responseClass",
|
||||
"match": [
|
||||
{
|
||||
"value": "2xx",
|
||||
"condition": "response.code >= 200 && response.code <= 299"
|
||||
},
|
||||
{
|
||||
"value": "3xx",
|
||||
"condition": "response.code >= 300 && response.code <= 399"
|
||||
},
|
||||
{
|
||||
"value": "404",
|
||||
"condition": "response.code == 404"
|
||||
},
|
||||
{
|
||||
"value": "429",
|
||||
"condition": "response.code == 429"
|
||||
},
|
||||
{
|
||||
"value": "503",
|
||||
"condition": "response.code == 503"
|
||||
},
|
||||
{
|
||||
"value": "5xx",
|
||||
"condition": "response.code >= 500 && response.code <= 599"
|
||||
},
|
||||
{
|
||||
"value": "4xx",
|
||||
"condition": "response.code >= 400 && response.code <= 499"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
{
|
||||
"attributes": [
|
||||
{
|
||||
"output_attribute": "istio_responseClass",
|
||||
"match": [
|
||||
{
|
||||
"value": "2xx",
|
||||
"condition": "response.code >= 200 && response.code <= 299"
|
||||
},
|
||||
{
|
||||
"value": "3xx",
|
||||
"condition": "response.code >= 300 && response.code <= 399"
|
||||
},
|
||||
{
|
||||
"value": "404",
|
||||
"condition": "response.code == 404"
|
||||
},
|
||||
{
|
||||
"value": "429",
|
||||
"condition": "response.code == 429"
|
||||
},
|
||||
{
|
||||
"value": "503",
|
||||
"condition": "response.code == 503"
|
||||
},
|
||||
{
|
||||
"value": "5xx",
|
||||
"condition": "response.code >= 500 && response.code <= 599"
|
||||
},
|
||||
{
|
||||
"value": "4xx",
|
||||
"condition": "response.code >= 400 && response.code <= 499"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
vm_config:
|
||||
runtime: envoy.wasm.runtime.null
|
||||
code:
|
||||
|
|
@ -264,22 +276,22 @@ spec:
|
|||
$ kubectl -n istio-system apply -f attribute_gen_service.yaml
|
||||
{{< /text >}}
|
||||
|
||||
1. Find the `stats-filter-1.8` `EnvoyFilter` resource from the `istio-system`
|
||||
1. Find the `stats-filter-{{< istio_version >}}` `EnvoyFilter` resource from the `istio-system`
|
||||
namespace, using the following command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ kubectl -n istio-system get envoyfilter | grep ^stats-filter-1.8
|
||||
stats-filter-1.8 2d
|
||||
$ kubectl -n istio-system get envoyfilter | grep ^stats-filter-{{< istio_version >}}
|
||||
stats-filter-{{< istio_version >}} 2d
|
||||
{{< /text >}}
|
||||
|
||||
1. Create a local file system copy of the `EnvoyFilter` configuration, using the
|
||||
following command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ kubectl -n istio-system get envoyfilter stats-filter-1.8 -o yaml > stats-filter-1.8.yaml
|
||||
$ kubectl -n istio-system get envoyfilter stats-filter-{{< istio_version >}} -o yaml > stats-filter-{{< istio_version >}}.yaml
|
||||
{{< /text >}}
|
||||
|
||||
1. Open `stats-filter-1.8.yaml` with a text editor and locate the
|
||||
1. Open `stats-filter-{{< istio_version >}}.yaml` with a text editor and locate the
|
||||
`name: istio.stats` extension configuration. Update it to map `response_code`
|
||||
dimension in the `requests_total` standard metric to `istio_responseClass` attribute.
|
||||
The updated configuration file section should look like the following.
|
||||
|
|
@ -294,21 +306,21 @@ spec:
|
|||
configuration:
|
||||
"@type": type.googleapis.com/google.protobuf.StringValue
|
||||
value: |
|
||||
{
|
||||
"metrics": [
|
||||
{
|
||||
"name": "requests_total",
|
||||
"dimensions": {
|
||||
"response_code": "istio_responseClass"
|
||||
}
|
||||
}]
|
||||
}
|
||||
{
|
||||
"metrics": [
|
||||
{
|
||||
"name": "requests_total",
|
||||
"dimensions": {
|
||||
"response_code": "istio_responseClass"
|
||||
}
|
||||
}]
|
||||
}
|
||||
{{< /text >}}
|
||||
|
||||
1. Save `stats-filter-1.8.yaml` and then apply the configuration using the following command:
|
||||
1. Save `stats-filter-{{< istio_version >}}.yaml` and then apply the configuration using the following command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ kubectl -n istio-system apply -f stats-filter-1.8.yaml
|
||||
$ kubectl -n istio-system apply -f stats-filter-{{< istio_version >}}.yaml
|
||||
{{< /text >}}
|
||||
|
||||
## Verify the results
|
||||
|
|
|
|||
Loading…
Reference in New Issue