如何在 Istio 中调试 EnvoyFilter？

Question

我有以下过滤器：

apiVersion: networking.istio.io/v1alpha3
kind: EnvoyFilter
metadata:
  name: proper-filter-name-here
  namespace: istio-system
spec:
  workloadSelector:
    labels:
      app: istio-ingressgateway
  configPatches:
    - applyTo: NETWORK_FILTER
      match:
        context: GATEWAY
        listener:
          filterChain:
            filter:
              name: "envoy.http_connection_manager"
      patch:
        operation: INSERT_BEFORE
        value:
          name: envoy.lua
          typed_config:
            "@type": "type.googleapis.com/envoy.config.filter.http.lua.v2.Lua"
            inlineCode: |
              function envoy_on_request(request_handle)
                 request_handle:logDebug("Hello World!")
              end

我正在检查网关的日志，它确实没有看起来像应用了过滤器。如何调试 EnvoyFilter？在哪里可以查看每个请求应用了哪些过滤器？

Answer 1

这个话题在the documentation中有很好的描述：

最简单的 Istio 日志记录是 Envoy’s access logging。 Envoy 代理将访问信息打印到其标准输出。然后可以通过kubectl logs 命令打印 Envoy 容器的标准输出。

你问过：

在哪里可以查看每个请求应用了哪些过滤器？

基于this issue on github：

没有通用机制。

因此，如果您想查看对每个请求应用了什么过滤器，则必须创建自定义解决方案。

但是，没有任何问题，您可以根据this fragment in the documentation获取有关每个请求的日志：

如果您使用 IstioOperator CR 安装 Istio，请将以下字段添加到您的配置中：

spec:
  meshConfig:
    accessLogFile: /dev/stdout

否则，将等效设置添加到您原来的istioctl install 命令中，例如：

istioctl  install  <flags-you-used-to-install-Istio> --set meshConfig.accessLogFile=/dev/stdout

您还可以通过将accessLogEncoding 设置为JSON 或TEXT 在JSON 和文本之间进行选择。 您可能还想通过编辑accessLogFormat 来自定义访问日志的format。

有关所有这三个设置的更多信息，请参阅global mesh options：

• meshConfig.accessLogFile
• meshConfig.accessLogEncoding
• meshConfig.accessLogFormat

您也可以通过链接指令change access log format 和test the access log。

另见（编辑）：

• How to debug your Istio networking configuration:

• EnvoyFilters 将显示在您告诉 Istio 放置它们的位置。通常，错误的 EnvoyFilter 将表现为 Envoy 拒绝配置（即未处于上述 SYNCED 状态），您需要检查 Istiod（Pilot）日志以了解来自 Envoy 拒绝配置的错误。

• 如果配置根本没有出现在 Envoy 中——Envoy 没有确认它，或者它是一个 EnvoyFilter 配置——很可能是配置无效（Istio 无法从语法上验证 EnvoyFilter 内部的配置）或者位于Envoy 配置中的错误位置。

• Debugging Envoy and Istiod
• Using EnvoyFilters to Debug Requests