Nasazení brány v místním prostředí do Kubernetes s integrací OpenTelemetry

PLATÍ PRO: Vývojář | Prémiová verze

Tento článek vysvětluje, jak nasadit komponentu brány azure API Management v místním prostředí do clusteru Kubernetes a automaticky odesílat všechny metriky do kolektoru OpenTelemetry.

Naučíte se, jak:

Konfigurace a nasazení samostatného kolektoru OpenTelemetry v Kubernetes
Nasazení samohostované brány s metrikami OpenTelemetry.
Generování metrik konzumací rozhraní API na samohostované bráně.
Použijte metriky z kolekce OpenTelemetry.

Požadavky

Vytvořte instanci služby Azure API Management.
Vytvořte cluster Azure Kubernetes pomocí Azure CLI, azure PowerShellu nebo webu Azure Portal.
Poskytněte samohostovaný prostředek brány v instanci služby API Management.
Nainstalujte Helm.

Úvod do OpenTelemetry

OpenTelemetry je sada opensourcových nástrojů a architektur pro protokolování, metriky a trasování způsobem neutrálním dodavatelem.

Bránu v místním prostředí je možné nakonfigurovat tak, aby automaticky shromažďovala a odesílala metriky do OpenTelemetry Collector. To vám umožní použít vlastní řešení shromažďování metrik a reportování pro bránu v místním prostředí.

Poznámka:

OpenTelemetry je inkubační projekt ekosystému CNCF (Cloud Native Computing Foundation).

Metriky

Brána v místním prostředí automaticky začne měřit následující metriky:

Žádosti
DélkaVMilisekundách
BackendDurationInMs
DobaTrváníKlientaVms
GatewayDurationInMs

Jsou automaticky exportovány do nakonfigurovaného kolektoru OpenTelemetry každou minutu a zahrnují další dimenze.

Nasazení OpenTelemetry Collectoru

Začněte nasazením samostatného kolektoru OpenTelemetry na Kubernetesu pomocí nástroje Helm.

Tip

I když používáme chart Helm kolektoru, poskytují také operátor kolektoru OpenTelemetry.

Začněte tím, že přidáte úložiště chartů Helm.

Pomocí následujícího příkazu přidejte úložiště Helm.

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

Aktualizujte úložiště tak, aby načítá nejnovější grafy Helmu.
```
helm repo update
```

Ověřte konfiguraci Helmu tak, že zobrazíte všechny dostupné grafy.

helm search repo open-telemetry

Následující příklad ukazuje dostupné grafy.

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

Teď, když máte nakonfigurované úložiště grafů, můžete do clusteru nasadit Kolekci OpenTelemetry:

Vytvořte místní konfigurační soubor s názvem opentelemetry-collector-config.yml s následující konfigurací:
```
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
```
To nám umožňuje používat samostatný kolektor s exportérem Prometheus vystaveným na portu 8889. Abychom zpřístupnili metriky Prometheus, řekneme Helm chart, aby nakonfiguroval LoadBalancer službu.

Poznámka:

Zakážete kompaktní port Jaeger, protože používá UDP a LoadBalancer služba neumožňuje mít současně více protokolů.

Nainstalujte Helm chart s vaší konfigurací.

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

Ověřte instalaci získáním všech prostředků pro Helm chart.

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

Poznamenejte si externí IP adresu služby, abyste ji mohli později dotazovat.

S nainstalovaným kolektorem OpenTelemetry nyní můžete nasadit samohosovanou bránu do vašeho clusteru.

Nasadit bránu hostovanou lokálně

Důležité

Podrobný přehled o tom, jak nasadit bránu v místním prostředí s Helmem a jak získat požadovanou konfiguraci, najdete v tématu Nasazení brány v místním prostředí do Kubernetes pomocí Nástroje Helm.

V této části nasadíte bránu v místním prostředí do clusteru pomocí nástroje Helm a nakonfigurujete ji tak, aby odesílala metriky OpenTelemetry do kolekce OpenTelemetry.

Tip

Následující kroky nasadí bránu v místním prostředí do Kubernetes a povolí ověřování do instance služby API Management pomocí přístupového tokenu brány (ověřovacího klíče). Samohostovanou bránu můžete také nasadit do Kubernetes a umožnit ověřování pro instanci služby API Management pomocí ID Microsoft Entra. Další informace najdete v tématu Možnosti ověřování brány v místním prostředí.

Nainstalujte chart Helm a nakonfigurujte ho tak, aby používal metriky 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

Poznámka:

opentelemetry-collector v tomto příkazu je název kolektoru OpenTelemetry. Pokud má vaše služba jiný název, aktualizujte ho.

Ověřte instalaci tím, že získáte všechny prostředky pro Helm chart.

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

Poznamenejte si externí IP adresu služby brány v místním prostředí, abyste ji mohli později dotazovat.

Generování a využívání metrik OpenTelemetry

Teď, když je nasazen OpenTelemetry Collector i brána hostovaná v místním prostředí, můžete začít využívat API ke generování metrik.

Poznámka:

Pro tento názorný postup používáte výchozí rozhraní API Echo.

Ujistěte se, že je nakonfigurovaná na:

Povolit požadavky HTTP
Umožněte, aby vaše samohostovaná brána ji zpřístupnila

Dotazujte se na Echo API v samo-hostované bráně.

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

Brána provozovaná na vlastním serveru měří požadavky a odesílá metriky do sběrače OpenTelemetry.

Proveďte dotaz na koncový bod Prometheus na kolektoru v systému http://<collector-service-ip>:8889/metrics. Měly by se zobrazit metriky podobné následujícímu příkladu:

# 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

Vyčistěte zdroje

Po dokončení kurzu můžete cluster snadno vyčistit pomocí následujících příkazů.

Odinstalujte Helm chart samohostované brány.
```
helm uninstall apim-gateway
```
Odinstalujte kolekci OpenTelemetry.
```
helm uninstall opentelemetry-collector
```

Váš názor

Byla tato stránka užitečná?

Last updated on 2026-03-11

Sdílet prostřednictvím

Nasazení brány v místním prostředí do Kubernetes s integrací OpenTelemetry

Požadavky

Úvod do OpenTelemetry

Metriky

Nasazení OpenTelemetry Collectoru

Nasadit bránu hostovanou lokálně

Generování a využívání metrik OpenTelemetry

Vyčistěte zdroje

Související obsah

Váš názor

Další materiály