自定义 Istio 指标

此任务向您展示如何自定义 Istio 生成的指标。

Istio 生成各种 dashboard 使用的遥测数据，以帮助您可视化您的网格。 例如，支持 Istio 的 dashboard 包括：

• Grafana
• Kiali
• Prometheus

默认情况下，Istio 定义并生成一组标准指标（例如： requests_total），但您也可以自定义它们并创建新指标。

自定义统计配置

Istio 使用 Envoy 代理生成指标并在 manifests/charts/istio-control/istio-discovery/templates/telemetryv2_1.17.yaml 文件的 EnvoyFilter 中提供配置。

配置自定义统计信息涉及 EnvoyFilter 的两个部分：definitions 和 metrics。 在 definitions 部分支持用名字、期望值表达式和指标类型（counter、gauge 和 histogram）创建新的指标。 在 metrics 的部分以表达式的形式提供指标维度的值，并允许您删除或覆盖现有的指标维度。 您可以调整标准指标定义， 利用 tags_to_remove 或重新定义维度。 这些配置设置也用 istioctl 安装选项公开， 允许您为网关和边车以及入站或出站方向自定义不同的指标。

有关详细信息，请参阅统计配置参考。

开始之前

在集群中安装 Istio并部署应用程序。 或者，您可以设置自定义统计作为 Istio 安装的一部分。

Bookinfo示例应用程序在整个任务中用作示例应用程序。

启用自定义指标

1. 默认遥测 v2 EnvoyFilter 配置等效于以下安装选项：

   apiVersion: install.istio.io/v1alpha1
   kind: IstioOperator
   spec:
     values:
       telemetry:
         v2:
           prometheus:
             configOverride:
               inboundSidecar:
                 disable_host_header_fallback: false
               outboundSidecar:
                 disable_host_header_fallback: false
               gateway:
                 disable_host_header_fallback: true

   要自定义遥测 v2 指标，例如，添加request_host 和 destination_port 维度到两者发出的 requests_total 指标 入站和出站方向的网关和边车，请更改安装选项，如下所示：

   您只需为要自定义的设置指定配置。 例如，仅自定义边车入站 requests_count 指标，您可以省略 配置中的 outboundSidecar 和 gateway 部分。 未指定设置将保留默认配置，相当于上面显示的显式设置。

   $ cat <<EOF > ./custom_metrics.yaml
   apiVersion: install.istio.io/v1alpha1
   kind: IstioOperator
   spec:
     values:
       telemetry:
         v2:
           prometheus:
             configOverride:
               inboundSidecar:
                 metrics:
                   - name: requests_total
                     dimensions:
                       destination_port: string(destination.port)
                       request_host: request.host
               outboundSidecar:
                 metrics:
                   - name: requests_total
                     dimensions:
                       destination_port: string(destination.port)
                       request_host: request.host
               gateway:
                 metrics:
                   - name: requests_total
                     dimensions:
                       destination_port: string(destination.port)
                       request_host: request.host
   EOF
   # istioctl install -f custom_metrics.yaml

2. 使用以下命令将以下注释应用到所有注入的 Pod 以及要提取到 Prometheus 时间序列中的维度列表：

   仅当您的维度不在 DefaultStatTags 列表才需要此步骤。

   apiVersion: apps/v1
   kind: Deployment
   spec:
     template: # pod template
       metadata:
         annotations:
           sidecar.istio.io/extraStatTags: destination_port,request_host

   要在网格范围内启用额外的标签，您可以添加 extraStatTags 到网格配置中：

   meshConfig:
     defaultConfig:
       extraStatTags:
        - destination_port
        - request_host

验证结果

将流量发送到网格。对于 Bookinfo 示例，请 http://$GATEWAY_URL/productpage 在您的网络浏览器中访问或发出以下命令：

$ curl "http://$GATEWAY_URL/productpage"

$GATEWAY_URL 是 Bookinfo 示例中设置的值。

使用以下命令验证 Istio 是否为您的新维度或修改后的维度生成数据：

$ kubectl exec "$(kubectl get pod -l app=productpage -o jsonpath='{.items[0].metadata.name}')" -c istio-proxy -- curl -sS 'localhost:15000/stats/prometheus' | grep istio_requests_total

例如，在输出中，找到指标 istio_requests_total 并验证它是否包含您的新维度。

代理开始应用配置可能需要很短的时间。如果未收到该指标，您可以在稍等片刻后重试发送请求，然后再次查找该指标。

对值使用表达式

指标配置中的值是常用表达式，这意味着您 JSON 中的字符必须双引号（例如：”‘string value’”）。 与 Mixer 表达式语言不同，不支持 pipe (|) 运算符，但您 可以使用 has 或 in 操作符来模拟它，例如：

has(request.host) ? request.host : "unknown"

有关详细信息，请参阅通用表达式语言。

Istio 公开了所有标准 Envoy 属性。 对等元数据可用作出站属性 upstream_peer 和入站属性 downstream_peer ，具有以下字段：

例如，要在出站配置中使用的对等 app 标签的表达式是 upstream_peer.labels['app'].value。

有关详细信息请参阅配置参考。