502 Gateway inválido - TooBigHeaders

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Sintoma

O aplicativo cliente recebe um código de status HTTP de 502 Bad Gateway com código de erro protocol.http.TooBigHeaders como resposta para chamadas de API.

Mensagem de erro

O aplicativo cliente recebe o seguinte código de resposta:

HTTP/1.1 502 Bad Gateway

Além disso, você pode observar a seguinte mensagem de erro:

{
   "fault":{
      "faultstring":"response headers size exceeding 25,600",
      "detail":{
         "errorcode":"protocol.http.TooBigHeaders"
      }
   }
}

Causas possíveis

Esse erro ocorre se o tamanho total dos cabeçalhos enviados pelo servidor de destino/back-end para o Apigee Edge como parte da resposta HTTP for maior que o limite permitido permitido no Apigee Edge.

Confira as possíveis causas desse erro:

Etapas comuns do diagnóstico

Use uma das seguintes ferramentas/técnicas para diagnosticar esse erro:

Causa: o tamanho dos cabeçalhos na resposta é maior que o limite permitido

Diagnóstico

1. Determine o código de falha, a origem da falha e o tamanho do payload da resposta para o erro observado usando o Monitoramento de APIs, a ferramenta Trace ou os registros de acesso do NGINX, conforme explicado em Etapas comuns do diagnóstico.
2. Se a origem da falha tiver o valor target, isso indica que a resposta enviada pelo servidor de destino/back-end para a Apigee tem cabeçalhos cujo tamanho é maior que o limite permitido no Apigee Edge.
3. Você pode validar se a resposta do destino/back-end tem cabeçalhos cujo tamanho era maior que o limite permitido usando um dos seguintes métodos:

   Mensagem de erro

   Para validar usando a mensagem de erro:

   Se você tiver acesso à mensagem de erro completa recebida do Apigee Edge, então consulte o faultstring. O faultstring indica que o tamanho do cabeçalho de resposta excedeu o limite permitido.

   Exemplo de mensagem de erro:

   "faultstring":"response headers size exceeding 25,600"

   Na mensagem de erro acima, observe na faultstring que a resposta tem cabeçalhos cujo tamanho total excede o limite permitido.

   Solicitação real

   Para validar usando a solicitação real:

   Se você tiver acesso à solicitação real feita para o servidor de destino/back-end, siga estas etapas:

   1. Se você for um usuário do Public Cloud/Private Cloud, faça uma solicitação diretamente para o servidor de back-end do próprio servidor de back-end ou de qualquer outra máquina em que você tenha permissão para fazer a solicitação.
   2. Se você for um usuário do Private Cloud, também poderá fazer a solicitação para o servidor de back-end de um dos processadores de mensagens.
   3. Examine a resposta recebida do servidor de back-end e, especificamente, calcule e verifique o tamanho total dos cabeçalhos transmitidos na resposta.

   4. Se você descobrir que o tamanho dos cabeçalhos no payload de resposta é maior que o limite permitido no Apigee Edge, essa é a causa do problema.

      Exemplo de resposta do servidor de destino:

      curl -v https://TARGET_SERVER_HOST/test
      

      * About to connect() to 10.1.0.10 port 9000 (#0)
      *   Trying 10.1.0.10...
      * Connected to 10.1.0.10 (10.1.0.10) port 9000 (#0)
      > GET /test HTTP/1.1
      > User-Agent: curl/7.29.0
      > Host: 10.1.0.10:9000
      > Accept: */*
      <
      < HTTP/1.1 200 OK
      < Accept-Ranges: bytes
      < Content-Length: 0
      < Content-Type: text/plain; charset=utf-8
      < Last-Modified: Tue, 20 Jul 2021 09:23:56 GMT
      < Testheader1: XVlBzgba—-<snipped>---THctcuAx
      < Testheader2: hxKQFDaFpLSj—-<snipped>---FbcXoEFfRsWxP
      < Date: Fri, 23 Jul 2021 09:51:22 GMT
      <
      * Connection #0 to host 10.1.0.10 left intact
      

      No exemplo acima, Testheader1 e Testheader2 têm tamanhos maiores, o que é a causa desse erro, já que excede o limite permitido no Apigee Edge.

   Registros do processador de mensagens

   Para validar usando registros do processador de mensagens:

   Se você for um usuário do Private Cloud, poderá usar os registros do processador de mensagens para validar se o tamanho dos cabeçalhos de resposta excedeu o limite permitido no Apigee Edge.

   1. Verifique os registros do processador de mensagens:

      /opt/apigee/var/log/edge-message-processor/logs/system.log

   2. Pesquise para saber se há erros 502 durante um período específico (se o problema aconteceu no passado) ou se ainda há solicitações com falha 502. Você pode usar a seguinte string de pesquisa:

      grep -ri "response headers size exceeding"
      

   3. Você vai encontrar linhas de system.log semelhantes às seguintes. O tamanho dos cabeçalhos de resposta pode variar no seu caso:

      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest rev:1
      messageid:r23ijb1b-1  NIOThread@1 ERROR HTTP.CLIENT -
      HTTPClient$Context$3.onException() :  ClientChannel[Connected:
      Remote:3.7.1.1:9000 Local:192.168.2.1:56098]@8414 useCount=1
      bytesRead=0 bytesWritten=207 age=640ms  lastIO=0ms  isOpen=true.onExceptionRead
      exception: {}
      com.apigee.errors.http.server.BadGateway: response headers size exceeding 25,600
      
      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest
      rev:1 messageid:r23ijb1b-1  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError
      (HTTPResponse@31f3ef88, response headers size exceeding 25,600)

   4. Assim que o processador de mensagens recebe a resposta do servidor de back-end/destino e descobre que o tamanho total dos cabeçalhos é maior que 25 KB, ele para e gera o erro:

      response headers size exceeding 25,600

      Isso implica que o tamanho total do cabeçalho é maior que 25 KB e o Apigee gera o erro quando o tamanho começa a exceder o limite de 25 KB com o código de falha como protocol.http.TooBigHeaders

Resolução

Limites

A Apigee espera que o aplicativo cliente e o servidor de back-end não enviem tamanhos de cabeçalho maiores que o limite permitido, conforme documentado para o tamanho do cabeçalho de solicitação/resposta em Limites do Apigee Edge.

1. Se você for um usuário do Public Cloud, o limite máximo para o tamanho dos cabeçalhos de solicitação e resposta será documentado para o tamanho do cabeçalho de solicitação/resposta em Limites do Apigee Edge.
2. Se você for um usuário do Private Cloud , poderá ter modificado o limite máximo padrão para o tamanho dos cabeçalhos de solicitação e resposta (embora não seja uma prática recomendada). Você pode determinar o limite máximo de tamanho do cabeçalho de resposta seguindo as instruções em Como verificar o limite atual.

Como verificar o limite atual?

Esta seção explica como verificar se a propriedade HTTPResponse.headers.limit foi atualizada com um novo valor nos processadores de mensagens.

1. Na máquina do processador de mensagens, pesquise a propriedade HTTPResponse.headers.limit no /opt/apigee/edge-message-processor/conf diretório e verifique qual valor foi definido, conforme mostrado abaixo:

   grep -ri "HTTPResponse.headers.limit" /opt/apigee/edge-message-processor/conf
   

2. O resultado de exemplo do comando acima é o seguinte:

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPResponse.headers.limit=25k

3. No exemplo de saída acima, observe que a propriedade HTTPResponse.headers.limit foi definida com o valor 25k em http.properties.

   Isso indica que o limite para o tamanho do payload de resposta configurado na Apigee para Private Cloud é de 25 KB.

Se você ainda precisar de ajuda do suporte da Apigee, acesse É necessário coletar informações de diagnóstico.

É necessário coletar informações de diagnóstico

Reúna as seguintes informações de diagnóstico e entre em contato com o suporte do Apigee Edge:

Se você for um usuário do Public Cloud, forneça as seguintes informações:

• Nome da organização
• Nome do ambiente
• Nome do proxy de API
• Comando curl completo usado para reproduzir o erro 502
• Arquivo de trace para as solicitações de API
• Saída completa da resposta do servidor de destino/back-end, juntamente com o tamanho dos cabeçalhos

Se você for um usuário do Private Cloud, forneça as seguintes informações:

• Mensagem de erro completa observada para as solicitações com falha
• Nome da organização
• Nome do ambiente
• Pacote de proxy de API
• Arquivo de trace para as solicitações de API com falha
• Comando curl completo usado para reproduzir o erro 502
• Saída completa da resposta do servidor de destino/back-end, juntamente com o tamanho dos cabeçalhos

• Registros de acesso do NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Em que: ORG, ENV e PORT# são substituídos por valores reais.

• Registros do sistema do processador de mensagens /opt/apigee/var/log/edge-message-processor/logs/system.log