OpenTelemetry 統合を使ってセルフホステッド ゲートウェイを Kubernetes にデプロイする
適用対象: Developer | Premium
この記事では、Azure API Management のセルフホステッド ゲートウェイ コンポーネントを Kubernetes クラスターにデプロイし、すべてのメトリックを OpenTelemetry Collector に自動的に送信する手順について説明します。
重要
Azure API Management セルフホステッド ゲートウェイの OpenTelemetry サポートは、現在プレビュー段階で、2.0.0 タグ以上が必要です。
以下の方法について説明します。
- Kubernetes 上でスタンドアロンの OpenTelemetry Collector を構成し、デプロイします
- OpenTelemetry メトリックを備えたセルフホステッド ゲートウェイをデプロイします。
- セルフホステッド ゲートウェイ上で API を使ってメトリックを生成します。
- OpenTelemetry Collector のメトリックを使います。
前提条件
- Azure API Management インスタンスを作成する
- Azure CLI、Azure PowerShell、または Azure portal を使用して Azure Kubernetes クラスターを作成します。
- API Management インスタンスでセルフホステッド ゲートウェイ リソースをプロビジョニングします。
OpenTelemetry の概要
OpenTelemetry は、ベンダーに依存しない方法でログ、メトリック、トレースを行う、オープンソースのツールとフレームワークのセットです。
重要
Azure API Management セルフホステッド ゲートウェイの OpenTelemetry サポートは、現在プレビュー段階で、2.0.0 タグ以上が必要です。
セルフホステッド ゲートウェイは、自動的にメトリックを収集して、OpenTelemetry Collector に送信するように構成できます。 これにより、セルフホステッド ゲートウェイに独自のメトリック収集とレポート ソリューションを導入することができます。
Note
OpenTelemetry は、Cloud Native Computing Foundation (CNCF) エコシステムの開発プロジェクトです。
メトリック
セルフホステッド ゲートウェイは、次のメトリックの測定を自動的に開始します。
- Requests
- DurationInMs
- BackendDurationInMs
- ClientDurationInMs
- GatewayDurationInMs
これらは、追加のディメンションと共に、構成された OpenTelemetry Collector に 1 分ごとに自動的にエクスポートされます。
OpenTelemetry Collector のデプロイ
まず、Helm を使ってスタンドアロンの OpenTelemetry Collector を Kubernetes 上にデプロイします。
ヒント
Collector の Helm チャートを使いますが、OpenTelemetry Collector Operator も提供されています
最初に、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 Collector をクラスターにデプロイできます。
次の構成で
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 サービスを構成する必要があります。
Note
コンパクト Jaeger ポートは UDP を使っており、LoadBalancer サービスでは複数のプロトコルを同時に使用できないため、ポートを無効にしています。
構成した内容で Helm チャートをインストールします。
helm install opentelemetry-collector open-telemetry/opentelemetry-collector --values .\opentelemetry-collector-config.ymlHelm チャートのすべてのリソースを取得して、インストールを確認します。
$ 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 Collector のインストールが完了したので、次にセルフホステッド ゲートウェイをクラスターにデプロイします。
セルフホステッド ゲートウェイをデプロイする
重要
Helm を使ったセルフホステッド ゲートウェイのデプロイ方法と、必要な構成を取得する方法の詳細については、こちらの記事を参照することをお勧めします。
このセクションでは、Helm を使ってクラスターにセルフホステッド ゲートウェイをデプロイし、OpenTelemetry Collector に 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
Note
上記のコマンドで、opentelemetry-collector は OpenTelemetry Collector の名前です。 サービスの名前が異なる場合は、名前を最新のものに更新してください。
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 Collector とセルフホステッド ゲートウェイの両方がデプロイされたので、API を使ってメトリックを生成することができます。
Note
このチュートリアルでは、既定の "Echo API" を使います。
以下のように構成されていることを確認してください。
- HTTP 要求を許可する
- セルフホステッド ゲートウェイによる公開を許可する
セルフホステッド ゲートウェイで 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:c24f5e00-aa25-47f2-bbb5-035847e7f52a X-Powered-By: Azure API Management - http://api.azure.com/,ASP.NET X-AspNet-Version: 4.0.30319
セルフホステッド ゲートウェイが要求を測定し、OpenTelemetry Collector にメトリックを送信します。
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-gatewayOpenTelemetry Collector をアンインストールします。
helm uninstall opentelemetry-collector
次のステップ
- セルフホステッド ゲートウェイの詳細については、セルフホステッド ゲートウェイの概要に関するページを参照してください。
- Azure API Management ゲートウェイの可観測性機能の詳細について学習します。