使用 OpenTelemetry 整合將自我裝載閘道部署至 Kubernetes

發行項
04/04/2024

適用於：開發人員 | 進階

本文中的步驟說明將 Azure API 管理的自我裝載閘道元件部署至 Kubernetes 叢集，並自動將所有計量傳送至 OpenTelemetry 收集器。

重要

Azure API 管理自我裝載閘道的 OpenTelemetry 支援目前為預覽版，需要 2.0.0 標籤或更新版本。

您將學習如何：

在 Kubernetes 上設定及部署獨立 OpenTelemetry 收集器
搭配 OpenTelemetry 計量部署自我裝載閘道。
在自我裝載閘道上取用 API 來產生計量。
使用 OpenTelemetry 收集器中的計量。

必要條件

建立 Azure API 管理執行個體
使用 Azure CLI、使用 Azure PowerShell 或使用 Azure 入口網站建立 Azure Kubernetes 叢集。
在 API 管理執行個體中佈建自我裝載閘道資源。

OpenTelemetry 簡介

OpenTelemetry 是秉持廠商中立性用於記錄、計量和追蹤的一組開放原始碼工具和架構。

重要

Azure API 管理自我裝載閘道的 OpenTelemetry 支援目前為預覽版，需要 2.0.0 標籤或更新版本。

自我裝載閘道可以設定為自動收集計量並傳送至 OpenTelemetry 收集器。這可讓您為自我裝載閘道自備計量集合和報告解決方案。

注意

OpenTelemetry 是 Cloud Native Computing Foundation (CNCF) 生態系統的培育專案。

計量

自我裝載閘道會自動開始測量下列計量：

要求
DurationInMs
BackendDurationInMs
ClientDurationInMs
GatewayDurationInMs

每 1 分鐘自動匯出至已設定的 OpenTelemetry 收集器，並附加額外維度。

部署 OpenTelemetry 收集器

首先，我們使用 Helm 在 Kubernetes 上部署獨立 OpenTelemetry 收集器。

提示

我們使用的收集器 Helm 圖表還提供 OpenTelemetry 收集器運算子

首先，我們必須新增 Helm 圖表存放庫：

新增 Helm 存放庫

helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts

更新存放庫以擷取最新的 Helm 圖表。
```
helm repo update
```

列出所有可用的圖表以確認 Helm 設定。

$ helm search repo open-telemetry
NAME                                    CHART VERSION   APP VERSION     DESCRIPTION
open-telemetry/opentelemetry-collector  0.8.1           0.37.1          OpenTelemetry Collector Helm chart for Kubernetes
open-telemetry/opentelemetry-operator   0.4.0           0.37.0          OpenTelemetry Operator Helm chart for Kubernetes

既然已設定圖表存放庫，接著可以將 OpenTelemetry 收集器部署到叢集：

使用下列設定建立名為 opentelemetry-collector-config.yml 的本機組態檔：

mode: deployment
config:
  exporters:
    prometheus:
      endpoint: "0.0.0.0:8889"
      namespace: azure_apim
      send_timestamps: true
  service:
    pipelines:
      metrics:
        exporters:
        - prometheus
service:
  type: LoadBalancer
ports:
  jaeger-compact:
    enabled: false
  prom-exporter:
    enabled: true
    containerPort: 8889
    servicePort: 8889
    protocol: TCP

這可讓我們搭配連接埠 8889 上公開的 Prometheus 匯出工具來使用獨立收集器。為了公開 Prometheus 計量，我們要求 Helm 圖表設定 LoadBalancer 服務。

注意

我們停用精簡的 Jaeger 連接埠，因為其使用 UDP，而且 LoadBalancer 服務不允許您同時有多個通訊協定。

使用我們的設定安裝 Helm 圖表：

helm install opentelemetry-collector open-telemetry/opentelemetry-collector --values .\opentelemetry-collector-config.yml

為 Helm 圖表取得所有資源以確認安裝

$ kubectl get all -l app.kubernetes.io/instance=opentelemetry-collector
NAME                                           READY   STATUS    RESTARTS   AGE
pod/opentelemetry-collector-58477c8c89-dstwd   1/1     Running   0          27m

NAME                              TYPE           CLUSTER-IP     EXTERNAL-IP    PORT(S)                                                                                       AGE
service/opentelemetry-collector   LoadBalancer   10.0.175.135   20.103.18.53   14250:30982/TCP,14268:32461/TCP,4317:31539/TCP,4318:31581/TCP,8889:32420/TCP,9411:30003/TCP   27m

NAME                                      READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/opentelemetry-collector   1/1     1            1           27m

NAME                                                 DESIRED   CURRENT   READY   AGE
replicaset.apps/opentelemetry-collector-58477c8c89   1         1         1       27m

記下服務的外部 IP，方便稍後查詢。

安裝 OpenTelemetry 收集器後，我們現在可以將自我裝載閘道部署到叢集。

部署自我裝載閘道

重要

有關如何使用 Helm 部署自我裝載閘道及如何取得必要設定的詳細概觀，建議閱讀這篇文章。

在本節中，我們會使用 Helm 將自我裝載閘道部署到叢集，並設定為將 OpenTelemetry 計量傳送至 OpenTelemetry 收集器。

安裝 Helm 圖表並設定為使用 OpenTelemetry 計量：

helm install azure-api-management-gateway \
             --set gateway.configuration.uri='<your configuration url>' \
             --set gateway.auth.key='<your auth token>' \
             --set observability.opentelemetry.enabled=true \
             --set observability.opentelemetry.collector.uri=http://opentelemetry-collector:4317 \
             --set service.type=LoadBalancer \
             azure-apim-gateway/azure-api-management-gateway

注意

上述命令中的 opentelemetry-collector 是 OpenTelemetry 收集器的名稱。如果您的服務有不同的名稱，請更新名稱。

為 Helm 圖表取得所有資源以確認安裝

$ kubectl get all -l app.kubernetes.io/instance=apim-gateway
NAME                                                            READY   STATUS    RESTARTS   AGE
pod/apim-gateway-azure-api-management-gateway-fb77c6d49-rffwq   1/1     Running   0          63m

NAME                                                TYPE           CLUSTER-IP    EXTERNAL-IP    PORT(S)                         AGE
service/apim-gateway-azure-api-management-gateway   LoadBalancer   10.0.67.177   20.71.82.110   8080:32267/TCP,8081:32065/TCP   63m

NAME                                                        READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/apim-gateway-azure-api-management-gateway   1/1     1            1           63m

NAME                                                                  DESIRED   CURRENT   READY   AGE
replicaset.apps/apim-gateway-azure-api-management-gateway-fb77c6d49   1         1         1       63m

記下自我裝載閘道服務的外部 IP，方便稍後查詢。

產生及取用 OpenTelemetry 計量

既然已部署 OpenTelemetry 收集器和自我裝載閘道，接著可以開始取用 API 來產生計量。

注意

在此逐步解說中我們取用預設 "Echo API"。

請務必設定為：

允許 HTTP 要求
允許自我裝載閘道公開 Echo API

在自我裝載閘道中查詢 Echo API：

$ curl -i "http://<self-hosted-gateway-ip>:8080/echo/resource?param1=sample&subscription-key=abcdef0123456789"
HTTP/1.1 200 OK
Date: Mon, 20 Dec 2021 12:58:09 GMT
Server: Microsoft-IIS/8.5
Content-Length: 0
Cache-Control: no-cache
Pragma: no-cache
Expires: -1
Accept: */*
Host: echoapi.cloudapp.net
User-Agent: curl/7.68.0
X-Forwarded-For: 10.244.1.1
traceparent: 00-3192030c89fd7a60ef4c9749d6bdef0c-f4eeeee46f770061-01
Request-Id: |3192030c89fd7a60ef4c9749d6bdef0c.f4eeeee46f770061.
Request-Context: appId=cid-v1:00001111-aaaa-2222-bbbb-3333cccc4444
X-Powered-By: Azure API Management - http://api.azure.com/,ASP.NET
X-AspNet-Version: 4.0.30319

自我裝載閘道現在會測量要求，並將計量傳送至 OpenTelemetry 收集器。

在位於 http://<collector-service-ip>:8889/metrics 的收集器上查詢 Prometheus 端點。您應該會看到類似如下的計量：

# HELP azure_apim_BackendDurationInMs 
# TYPE azure_apim_BackendDurationInMs histogram
azure_apim_BackendDurationInMs_bucket{Hostname="20.71.82.110",le="5"} 0 1640093731340
[...]
azure_apim_BackendDurationInMs_count{Hostname="20.71.82.110"} 22 1640093731340
# HELP azure_apim_ClientDurationInMs 
# TYPE azure_apim_ClientDurationInMs histogram
azure_apim_ClientDurationInMs_bucket{Hostname="20.71.82.110",le="5"} 22 1640093731340
[...]
azure_apim_ClientDurationInMs_count{Hostname="20.71.82.110"} 22 1640093731340
# HELP azure_apim_DurationInMs 
# TYPE azure_apim_DurationInMs histogram
azure_apim_DurationInMs_bucket{Hostname="20.71.82.110",le="5"} 0 1640093731340
[...]
azure_apim_DurationInMs_count{Hostname="20.71.82.110"} 22 1640093731340
# HELP azure_apim_GatewayDurationInMs 
# TYPE azure_apim_GatewayDurationInMs histogram
azure_apim_GatewayDurationInMs_bucket{Hostname="20.71.82.110",le="5"} 0 1640093731340
[...]
azure_apim_GatewayDurationInMs_count{Hostname="20.71.82.110"} 22 1640093731340
# HELP azure_apim_Requests 
# TYPE azure_apim_Requests counter
azure_apim_Requests{BackendResponseCode="200",BackendResponseCodeCategory="2xx",Cache="None",GatewayId="Docs",Hostname="20.71.82.110",LastErrorReason="None",Location="GitHub",ResponseCode="200",ResponseCodeCategory="2xx",Status="Successful"} 22 1640093731340

清除

既然已結束教學課程，您可以輕鬆清除叢集，如下所示：

解除安裝自我裝載閘道 Helm 圖表：
```
helm uninstall apim-gateway
```
解除安裝 OpenTelemetry 收集器：
```
helm uninstall opentelemetry-collector
```

下一步

若要深入了解自我裝載閘道，請參閱自我裝載閘道概觀。

深入了解 Azure API 管理閘道的可檢視性功能。

將自我裝載閘道部署至已啟用 Azure Arc 的 Kubernetes 叢集

共用方式為