OpenTelemetry

Envoy 代理可以配置为以 访问日志 格式导出其 OpenTelemetry 格式。在本示例中，代理将访问日志发送到 OpenTelemetry 收集器，该收集器配置为将日志打印到标准输出。然后可以通过 kubectl logs 命令访问 OpenTelemetry 收集器的标准输出。

开始之前

• 按照 安装指南 中的说明设置 Istio。

• 部署 curl 示例应用程序作为发送请求的测试来源。如果您启用了 自动 sidecar 注入，请运行以下命令来部署示例应用程序

  压缩

  $ kubectl apply -f @samples/curl/curl.yaml@
  

  否则，在使用以下命令部署 curl 应用程序之前，手动注入 sidecar

  压缩

  $ kubectl apply -f <(istioctl kube-inject -f @samples/curl/curl.yaml@)
  

• 将 SOURCE_POD 环境变量设置为源 Pod 的名称

  $ export SOURCE_POD=$(kubectl get pod -l app=curl -o jsonpath={.items..metadata.name})
  

• 启动 httpbin 示例。

  如果您启用了 自动 sidecar 注入，请部署 httpbin 服务

  压缩

  $ kubectl apply -f @samples/httpbin/httpbin.yaml@
  

  否则，您必须在部署 httpbin 应用程序之前手动注入 sidecar

  压缩

  $ kubectl apply -f <(istioctl kube-inject -f @samples/httpbin/httpbin.yaml@)
  

• 为 OpenTelemetry 收集器创建一个命名空间

  $ kubectl create namespace observability
  

• 部署 OpenTelemetry 收集器。您可以使用此示例配置作为起点：otel.yaml

  压缩

  $ kubectl apply -f @samples/open-telemetry/otel.yaml@ -n observability
  

启用 Envoy 的访问日志记录

要启用访问日志记录，请使用 遥测 API。

编辑 MeshConfig 以添加名为 otel 的 OpenTelemetry 提供程序。这涉及添加扩展提供程序段

extensionProviders:
- name: otel
  envoyOtelAls:
    service: opentelemetry-collector.observability.svc.cluster.local
    port: 4317

最终配置应如下所示

apiVersion: v1
kind: ConfigMap
metadata:
  name: istio
  namespace: istio-system
data:
  mesh: |-
    accessLogFile: /dev/stdout
    defaultConfig:
      discoveryAddress: istiod.istio-system.svc:15012
      proxyMetadata: {}
      tracing:
        zipkin:
          address: zipkin.istio-system:9411
    enablePrometheusMerge: true
    extensionProviders:
    - name: otel
      envoyOtelAls:
        service: opentelemetry-collector.observability.svc.cluster.local
        port: 4317
    rootNamespace: istio-system
    trustDomain: cluster.local
  meshNetworks: 'networks: {}'

接下来，添加一个遥测资源，指示 Istio 将访问日志发送到 OpenTelemetry 收集器。

$ cat <<EOF | kubectl apply -n default -f -
apiVersion: telemetry.istio.io/v1
kind: Telemetry
metadata:
  name: curl-logging
spec:
  selector:
    matchLabels:
      app: curl
  accessLogging:
    - providers:
      - name: otel
EOF

以上示例使用 otel 访问日志提供程序，我们没有配置除默认设置以外的任何内容。

类似的配置也可以应用于单个命名空间或单个工作负载，以控制细粒度的日志记录。

有关使用遥测 API 的更多信息，请参见 遥测 API 概述。

使用网格配置

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

spec:
  meshConfig:
    accessLogFile: /dev/stdout
    extensionProviders:
    - name: otel
      envoyOtelAls:
        service: opentelemetry-collector.observability.svc.cluster.local
        port: 4317
    defaultProviders:
      accessLogging:
      - envoy
      - otel

否则，将等效设置添加到原始 istioctl install 命令中，例如

$ istioctl install -f <your-istio-operator-config-file>

默认访问日志格式

如果未指定 accessLogFormat，Istio 将使用以下默认访问日志格式

[%START_TIME%] \"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%\" %RESPONSE_CODE% %RESPONSE_FLAGS% %RESPONSE_CODE_DETAILS% %CONNECTION_TERMINATION_DETAILS%
\"%UPSTREAM_TRANSPORT_FAILURE_REASON%\" %BYTES_RECEIVED% %BYTES_SENT% %DURATION% %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)% \"%REQ(X-FORWARDED-FOR)%\" \"%REQ(USER-AGENT)%\" \"%REQ(X-REQUEST-ID)%\"
\"%REQ(:AUTHORITY)%\" \"%UPSTREAM_HOST%\" %UPSTREAM_CLUSTER% %UPSTREAM_LOCAL_ADDRESS% %DOWNSTREAM_LOCAL_ADDRESS% %DOWNSTREAM_REMOTE_ADDRESS% %REQUESTED_SERVER_NAME% %ROUTE_NAME%\n

下表显示了使用默认访问日志格式从 curl 发送到 httpbin 的请求的示例

测试访问日志

1. 从 curl 发送到 httpbin 的请求

   $ kubectl exec "$SOURCE_POD" -c curl -- curl -sS -v httpbin:8000/status/418
   ...
   < HTTP/1.1 418 Unknown
   ...
   < server: envoy
   ...
   I'm a teapot!
   ...
   

2. 检查 otel-collector 的日志

   $ kubectl logs -l app=opentelemetry-collector -n observability
   [2020-11-25T21:26:18.409Z] "GET /status/418 HTTP/1.1" 418 - via_upstream - "-" 0 135 3 1 "-" "curl/7.73.0-DEV" "84961386-6d84-929d-98bd-c5aee93b5c88" "httpbin:8000" "127.0.0.1:80" inbound|8000|| 127.0.0.1:41854 10.44.1.27:80 10.44.1.23:37652 outbound_.8000_._.httpbin.foo.svc.cluster.local default
   

请注意，与请求相对应的消息会分别出现在源和目标 (curl 和 httpbin) 的 Istio 代理的日志中。您可以在日志中看到 HTTP 动词 (GET)、HTTP 路径 (/status/418)、响应代码 (418) 和其他 与请求相关的信息。

清理

关闭 curl 和 httpbin 服务

$ kubectl delete telemetry curl-logging
$ kubectl delete -f @samples/curl/curl.yaml@
$ kubectl delete -f @samples/httpbin/httpbin.yaml@
$ kubectl delete -f @samples/open-telemetry/otel.yaml@ -n istio-system
$ kubectl delete namespace observability

禁用 Envoy 的访问日志记录

删除或将 Istio 安装配置中的 meshConfig.extensionProviders 和 meshConfig.defaultProviders 设置设置为 ""。

$ istioctl install --set profile=default
✔ Istio core installed
✔ Istiod installed
✔ Ingress gateways installed
✔ Installation complete