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

  • Článek

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

Tento článek popisuje postup nasazení komponenty brány v místním prostředí služby Azure API Management do clusteru Kubernetes a automatické odesílání všech metrik do kolektoru OpenTelemetry.

Důležité

Podpora OpenTelemetry pro místní bránu služby Azure API Management je aktuálně ve verzi Preview a vyžaduje 2.0.0 značku nebo vyšší.

Získáte informace pro:

  • Konfigurace a nasazení samostatného kolektoru OpenTelemetry v Kubernetes
  • Nasaďte bránu v místním prostředí s metrikami OpenTelemetry.
  • Generování metrik pomocí rozhraní API v bráně v místním prostředí
  • Použijte metriky z kolekce OpenTelemetry.

Požadavky

Ú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.

Důležité

Podpora OpenTelemetry pro místní bránu služby Azure API Management je aktuálně ve verzi Preview a vyžaduje 2.0.0 značku nebo vyšší.

Bránu v místním prostředí je možné nakonfigurovat tak, aby automaticky shromažďovala a odesílala metriky do kolekce OpenTelemetry. To vám umožní použít vlastní řešení shromažďování metrik a vytváření sestav 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í začne automaticky měřit následující metriky:

  • Žádosti
  • DurationInMs
  • BackendDurationInMs
  • ClientDurationInMs
  • GatewayDurationInMs

Automaticky se exportují do nakonfigurovaného kolektoru OpenTelemetry každých 1 minutu s dalšími rozměry.

Nasazení kolekce OpenTelemetry

Začneme nasazením samostatného kolektoru OpenTelemetry v Kubernetes pomocí Nástroje Helm.

Tip

I když budeme používat chart Collector Helm, poskytují také operátor kolektoru OpenTelemetry.

Abychom mohli začít, musíme přidat úložiště chartů Helm:

  1. Přidání úložiště Helm

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

  2. Aktualizujte úložiště, aby se načítá nejnovější grafy Helm.

    helm repo update

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

    $ 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

Teď, když máme nakonfigurované úložiště grafů, můžeme do našeho clusteru nasadit Kolekci OpenTelemetry:

  1. 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 vývozcem Prometheus vystaveným na přístavu 8889. Abychom mohli zveřejnit metriky Prometheus, žádáme chart Helm, aby nakonfigurovali LoadBalancer službu.

Poznámka:

Zakazujeme kompaktní port Jaeger, protože používá UDP a LoadBalancer služba neumožňuje mít více protokolů najednou.

  1. Nainstalujte chart Helm s naší konfigurací:

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

  2. Ověření instalace získáním všech prostředků pro náš chart 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

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

S nainstalovanou kolekcí OpenTelemetry teď můžeme nasadit bránu v místním prostředí do našeho clusteru.

Nasazení brány v místním prostředí

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, doporučujeme si přečíst tento článek.

V této části nasadíme bránu v místním prostředí do našeho clusteru s Helmem a nakonfigurujeme ji tak, aby odesílala metriky OpenTelemetry do kolekce OpenTelemetry.

  1. 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 příkazu výše je název Kolekce OpenTelemetry. Pokud má vaše služba jiný název, aktualizujte ho.

  1. Ověření instalace získáním všech prostředků pro náš chart 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

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

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

Teď, když je nasazená naše kolekce OpenTelemetry i brána v místním prostředí, můžeme začít využívat rozhraní API ke generování metrik.

Poznámka:

V tomto názorném postupu budeme využívat výchozí rozhraní ECHO API.

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

  • Povolit požadavky HTTP
  • Povolit, aby brána v místním prostředí zpřístupňovala

  1. Dotazování rozhraní Echo API v bráně v místním prostředí:

    $ 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

Brána v místním prostředí teď bude měřit požadavek a odesílat metriky do kolekce OpenTelemetry.

  1. Dotazování koncového bodu Prometheus na kolektoru v systému http://<collector-service-ip>:8889/metrics. Měly by se zobrazit metriky podobné následujícímu:

    # 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čištění

Teď, když je kurz hotový, můžete cluster snadno vyčistit následujícím postupem:

  1. Odinstalujte chart Helm brány v místním prostředí:

    helm uninstall apim-gateway

  2. Odinstalujte kolekci OpenTelemetry:

    helm uninstall opentelemetry-collector

Další kroky

  • Další informace o bráně v místním prostředí najdete v přehledu brány v místním prostředí.