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 Collector 建立命名空間

  $ kubectl create namespace observability
  

• 部署 OpenTelemetry Collector。您可以使用此範例配置作為起點：otel.yaml

  壓縮

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

啟用 Envoy 的存取記錄

若要啟用存取日誌記錄，請使用Telemetry 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: {}'

接下來，新增一個 Telemetry 資源，告知 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 存取日誌提供者，我們除了預設設定外未配置任何其他設定。

類似的配置也可以應用於個別命名空間或個別工作負載，以精細地控制日誌記錄。

有關使用 Telemetry API 的更多資訊，請參閱Telemetry 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
   

請注意，與請求相對應的訊息會出現在來源和目的地的 Istio 代理日誌中，分別為 curl 和 httpbin。您可以在日誌中看到 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