Compartilhar via


Implantar o gateway auto-hospedado no Kubernetes com integração do OpenTelemetry

APLICA-SE A: Desenvolvedor | Premium

Este artigo descreve as etapas para implantar o componente de gateway auto-hospedado do Gerenciamento de API do Azure para um cluster Kubernetes e enviar automaticamente todas as métricas para um OpenTelemetry Collector.

Importante

O suporte do OpenTelemetry para o gateway auto-hospedado do Gerenciamento de API do Azure está atualmente em versão preliminar e requer marca 2.0.0 ou superior.

Você aprenderá como:

  • Configurar e implantar um coletor OpenTelemetry autônomo no Kubernetes
  • Implantar o gateway auto-hospedado com métricas do OpenTelemetry.
  • Gerar métricas consumindo APIs no gateway de hospedagem interna.
  • Usar as métricas do OpenTelemetry Collector.

Pré-requisitos

Introdução ao OpenTelemetry

OpenTelemetry é um conjunto de ferramentas e estruturas de software de código aberto para registro, métricas e rastreamento de maneira neutra em relação a fornecedor.

Importante

O suporte do OpenTelemetry para o gateway auto-hospedado do Gerenciamento de API do Azure está atualmente em versão preliminar e requer marca 2.0.0 ou superior.

O gateway auto-hospedado pode ser configurado para coletar e enviar métricas automaticamente para um OpenTelemetry Collector. Isso permite que você traga sua própria solução de coleta e relatório de métricas para o gateway auto-hospedado.

Observação

OpenTelemetry é um projeto de incubação do ecossistema da Cloud Native Computing Foundation (CNCF).

Métricas

O gateway auto-hospedado iniciará automaticamente a medição das seguintes métricas:

  • Requests
  • DurationInMs
  • BackendDurationInMs
  • ClientDurationInMs
  • GatewayDurationInMs

Elas são exportadas automaticamente para o coletor OpenTelemetry configurado a cada 1 minuto com dimensões adicionais.

O que é o OpenTelemetry Collector

Vamos começar implantando um OpenTelemetry Collector autônomo no Kubernetes usando o Helm.

Dica

Embora usemos o gráfico do Helm do Collector, eles também fornecem um OpenTelemetry Collector Operator

Para começar, precisamos adicionar o repositório do gráfico do Helm:

  1. Adicione o repositório do Helm

    helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
    
  2. Atualize o repositório para buscar os gráficos mais recentes do Helm.

    helm repo update
    
  3. Verifique a configuração do Helm listando todos os gráficos disponíveis.

    $ 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
    

Agora que temos o repositório do gráfico configurado, podemos implantar OpenTelemetry Collector em nosso cluster:

  1. Crie um arquivo de configuração local chamado opentelemetry-collector-config.yml com a seguinte configuração:

    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
    

Isso nos permite usar um coletor autônomo com o exportador Prometheus sendo exposto na porta 8889. Para expor as métricas do Prometheus, estamos pedindo que o gráfico do Helm configure um serviço de LoadBalancer.

Observação

Estamos desabilitando a porta compacta Jaeger, pois ela usa UDP e o serviço LoadBalancer não permite que você tenha vários protocolos ao mesmo tempo.

  1. Instale o gráfico do Helm com nossa configuração:

    helm install opentelemetry-collector open-telemetry/opentelemetry-collector --values .\opentelemetry-collector-config.yml
    
  2. Verifique a instalação obtendo todos os recursos para nosso gráfico do 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. Anote o IP externo do serviço para que possamos consultá-lo mais tarde.

Com nosso OpenTelemetry Collector instalado, agora podemos implantar o gateway auto-hospedado em nosso cluster.

Implantar um gateway auto-hospedado

Importante

Para obter uma visão geral detalhada sobre como implantar o gateway auto-hospedado com o Helm e como obter a configuração necessária, recomendamos a leitura deste artigo.

Nesta seção, vamos implantar o gateway auto-hospedado em nosso cluster com o Helm e configurá-lo para enviar métricas do OpenTelemetry para o OpenTelemetry Collector.

  1. Instale o gráfico do Helm e configure-o para usar as métricas do 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
    

Observação

opentelemetry-collector no comando acima, está o nome do OpenTelemetry Collector. Atualize o nome se o seu serviço tiver um nome diferente.

  1. Verifique a instalação obtendo todos os recursos para nosso gráfico do 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. Anote o IP externo do serviço do gateway de auto-hospedagem, para que possamos consultá-lo mais tarde.

Gerar e consumir as métricas do OpenTelemetry

Agora que o nosso OpenTelemetry Collector e o gateway auto-hospedado estão implantados, podemos começar a consumir as APIs para gerar métricas.

Observação

Consumiremos a "EchoAPI" padrão neste tutorial.

Verifique se ela está configurada para:

  • Permitir solicitações HTTP
  • Permitir que o gateway auto-hospedado a exponha
  1. Consulte a API Echo no gateway auto-hospedado:

    $ 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
    

Agora, o gateway auto-hospedado medirá a solicitação e enviará as métricas para o OpenTelemetry Collector.

  1. Consultar ponto de extremidade do Prometheus no coletor no http://<collector-service-ip>:8889/metrics. Você deverá ver métricas semelhantes a essas:

    # 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
    

Limpeza

Agora que o tutorial terminou, você pode facilmente limpar o cluster da seguinte maneira:

  1. Desinstale o gateway auto-hospedado usando o gráfico do Helm:

    helm uninstall apim-gateway
    
  2. Desinstale o OpenTelemetry Collector:

    helm uninstall opentelemetry-collector
    

Próximas etapas