502 Bad Gateway: TooBigHeaders

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Síntoma

La aplicación cliente obtiene un código de estado HTTP 502 Bad Gateway con código de error protocol.http.TooBigHeaders como respuesta para las llamadas a la API.

Mensaje de error

La aplicación cliente obtiene el siguiente código de respuesta:

HTTP/1.1 502 Bad Gateway

Además, es posible que observes el siguiente mensaje de error:

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

Causas posibles

Este error se produce si el tamaño total de los encabezados que envía el servidor de destino o de backend a Apigee Edge como parte de la respuesta HTTP es mayor que el límite permitido en Apigee Edge.

Estas son las posibles causas de este error:

Pasos comunes de diagnóstico

Usa una de las siguientes herramientas o técnicas para diagnosticar este error:

Causa: El tamaño de los encabezados en la respuesta es mayor que el límite permitido

Diagnóstico

1. Determina el Código de falla, la Fuente de falla y el Tamaño de la carga útil de la respuesta para el error observado con la Supervisión de API, la herramienta Trace o los registros de acceso de NGINX como se explica en Pasos comunes de diagnóstico.
2. Si la Fuente de falla tiene el valor target, eso indica que la respuesta que envía el servidor de destino o de backend a Apigee tiene encabezados cuyo tamaño es mayor que el límite permitido en Apigee Edge.
3. Puedes validar que la respuesta del destino o del backend tiene encabezados cuyo tamaño es mayor que el límite permitido con uno de los siguientes métodos:

   Mensaje de error

   Para validar con el mensaje de error, haz lo siguiente:

   Si tienes acceso al mensaje de error completo que recibiste de Apigee Edge, entonces consulta el faultstring. El faultstring indica que el tamaño del encabezado de respuesta superó el límite permitido.

   Mensaje de error de muestra:

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

   En el mensaje de error anterior, observa en el faultstringque la respuesta tiene encabezados cuyo tamaño total supera el límite permitido.

   Solicitud real

   Para validar con la solicitud real, haz lo siguiente:

   Si tienes acceso a la solicitud real realizada al servidor de destino o de backend, sigue estos pasos:

   1. Si eres usuario de la nube pública o privada, realiza una solicitud directamente al servidor de backend desde el propio servidor de backend o cualquier otra máquina desde la que tengas permiso para realizar la solicitud al servidor de backend.
   2. Si eres usuario de la nube privada, también puedes realizar la solicitud a el servidor de backend desde uno de los Message Processors.
   3. Examina la respuesta recibida del servidor de backend y, en particular, calcula y verifica el tamaño total de los encabezados que se pasan en la respuesta.

   4. Si descubres que el tamaño de los encabezados en la carga útil de la respuesta es mayor que el límite permitido en Apigee Edge, esa es la causa del problema.

      Esta es una muestra de una respuesta del 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
      

      En el ejemplo anterior, Testheader1 y Testheader2 tienen tamaños más grandes, lo que es la causa de este error, ya que supera el límite permitido en Apigee Edge.

   Registros de Message Processor

   Para validar con los registros de Message Processor, haz lo siguiente:

   Si eres usuario de la nube privada, puedes usar los registros de Message Processor para validar si el tamaño de los encabezados de respuesta superó el límite permitido en Apigee Edge.

   1. Verifica los registros de Message Processor:

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

   2. Busca para ver si hay errores 502 durante un período específico (si el problema ocurrió en el pasado) o si aún hay solicitudes que fallan con 502. Puedes usar la siguiente cadena de búsqueda:

      grep -ri "response headers size exceeding"
      

   3. Encontrarás líneas de system.log similares a las siguientes. El tamaño de los encabezados de respuesta puede variar en tu 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. En cuanto el Message Processor obtiene la respuesta del servidor de backend o de destino y descubre que el tamaño total de los encabezados es mayor que 25 KB, se detiene y muestra el error:

      response headers size exceeding 25,600

      Esto implica que el tamaño total del encabezado es mayor que 25 KB y Apigee muestra el error cuando el tamaño comienza a superar el límite de 25 KB con el código de falla como protocol.http.TooBigHeaders

Solución

Límites

Apigee espera que la aplicación cliente y el servidor de backend no envíen tamaños de encabezado mayores que el límite permitido, como se documenta para el tamaño del encabezado de solicitud o respuesta en los límites de Apigee Edge.

1. Si eres usuario de la nube pública, el límite máximo para el tamaño de los encabezados de solicitud y respuesta es el que se documenta para el tamaño del encabezado de solicitud o respuesta en los límites de Apigee Edge.
2. Si eres usuario de la nube privada, es posible que hayas modificado el límite máximo predeterminado para el tamaño de los encabezados de solicitud y respuesta (aunque no es una práctica recomendada). Puedes determinar el límite máximo de tamaño del encabezado de respuesta siguiendo las instrucciones en Cómo verificar el límite actual.

¿Cómo verificar el límite actual?

En esta sección, se explica cómo verificar que la propiedad HTTPResponse.headers.limit se haya actualizado con un valor nuevo en los Message Processors.

1. En la máquina Message Processor, busca la propiedad HTTPResponse.headers.limit en el directorio /opt/apigee/edge-message-processor/conf y verifica qué valor se estableció como se muestra a continuación:

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

2. El resultado de muestra del comando anterior es el siguiente:

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

3. En el resultado de ejemplo anterior, observa que la propiedad HTTPResponse.headers.limit se estableció con el valor 25k en http.properties.

   Esto indica que el límite para el tamaño de la carga útil de respuesta configurado en Apigee para la nube privada es de 25 KB.

Si aún necesitas asistencia de Apigee, consulta Se debe recopilar información de diagnóstico.

Se debe recopilar información de diagnóstico

Recopila la siguiente información de diagnóstico y, luego, comunícate con Asistencia de Apigee Edge:

Si eres usuario de la nube pública, proporciona la siguiente información:

• Nombre de la organización
• Nombre del entorno
• Nombre del proxy de API
• Comando curl completo que se usó para reproducir el error 502
• Archivo de seguimiento de las solicitudes a la API
• Resultado completo de la respuesta del servidor de destino o de backend junto con el tamaño de los encabezados

Si eres usuario de la nube privada, proporciona la siguiente información:

• Mensaje de error completo observado para las solicitudes fallidas
• Nombre de la organización
• Nombre del entorno
• Paquete de proxy de API
• Archivo de seguimiento de las solicitudes a la API fallidas
• Comando curl completo que se usó para reproducir el error 502
• Resultado completo de la respuesta del servidor de destino o de backend junto con el tamaño de los encabezados

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

  Donde: ORG, ENV y PORT# se reemplazan por valores reales.

• Registros del sistema de Message Processor /opt/apigee/var/log/edge-message-processor/logs/system.log