502 Bad Gateway – TooBigHeaders

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Problème constaté

L'application cliente reçoit un code d'état HTTP 502 Bad Gateway avec le code d'erreur protocol.http.TooBigHeaders en réponse aux appels d'API.

Message d'erreur

L'application cliente reçoit le code de réponse suivant :

HTTP/1.1 502 Bad Gateway

Vous pouvez également observer le message d'erreur suivant :

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

Causes possibles

Cette erreur se produit si la taille totale des en-têtes envoyés par le serveur cible/backend à Apigee Edge dans le cadre de la réponse HTTP est supérieure à la limite autorisée autorisée dans Apigee Edge.

Voici les causes possibles de cette erreur :

Étapes de diagnostic courantes

Utilisez l'un des outils/techniques suivants pour diagnostiquer cette erreur :

Cause : La taille des en-têtes dans la réponse est supérieure à la limite autorisée

Diagnostic

1. Déterminez le code d'erreur, la source de l'erreur et la taille de la charge utile de la réponse pour l' erreur observée à l'aide de la surveillance des API, de l'outil Trace ou des journaux d'accès NGINX, comme expliqué dans les étapes de diagnostic courantes.
2. Si la source de l'erreur a la valeur target, cela indique que la réponse envoyée par le serveur cible/backend à Apigee comporte des en-têtes dont la taille est supérieure à la limite autorisée dans Apigee Edge.
3. Vous pouvez vérifier que la réponse de la cible/du backend comporte des en-têtes dont la taille est supérieure à la limite autorisée à l'aide de l'une des méthodes suivantes :

   Message d'erreur

   Pour effectuer la validation à l'aide du message d'erreur :

   Si vous avez accès au message d'erreur complet reçu d'Apigee Edge, alors consultez le faultstring. Le faultstring indique que la taille de l'en-tête de réponse a dépassé la limite autorisée.

   Exemple de message d'erreur :

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

   Dans le message d'erreur ci-dessus, notez dans le faultstring que la réponse comporte des en-têtes dont la taille totale dépasse la limite autorisée.

   Requête réelle

   Pour effectuer la validation à l'aide de la requête réelle :

   Si vous avez accès à la requête réelle adressée au serveur cible/backend, procédez comme suit :

   1. Si vous êtes un utilisateur de Public Cloud/Private Cloud, adressez une requête directement au serveur backend à partir du serveur backend lui-même ou de toute autre machine à partir de laquelle vous êtes autorisé à adresser la requête au serveur backend.
   2. Si vous êtes un utilisateur de Private Cloud, vous pouvez également adresser la requête au serveur backend à partir de l'un des processeurs de messages.
   3. Examinez la réponse reçue du serveur backend, puis calculez et vérifiez spécifiquement la taille totale des en-têtes transmis dans la réponse.

   4. Si vous constatez que la taille des en-têtes dans la charge utile de la réponse est supérieure à la limite autorisée dans Apigee Edge, il s'agit de la cause du problème.

      Exemple de réponse du serveur cible :

      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
      

      Dans l'exemple ci-dessus, Testheader1 et Testheader2 ont des tailles plus élevées, ce qui est la cause de cette erreur, car elles dépassent la limite autorisée dans Apigee Edge.

   Journaux du processeur de messages

   Pour effectuer la validation à l'aide des journaux du processeur de messages :

   Si vous êtes un utilisateur de Private Cloud, vous pouvez utiliser les journaux du processeur de messages pour vérifier si la taille des en-têtes de réponse a dépassé la limite autorisée dans Apigee Edge.

   1. Consultez les journaux du processeur de messages :

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

   2. Recherchez les erreurs 502 pendant une durée spécifique (si le problème s'est produit dans le passé) ou si des requêtes échouent toujours avec l'erreur 502. Vous pouvez utiliser la chaîne de recherche suivante :

      grep -ri "response headers size exceeding"
      

   3. Vous trouverez des lignes de system.log semblables à celles-ci. La taille des en-têtes de réponse peut varier dans votre cas :

      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. Dès que le processeur de messages reçoit la réponse du serveur backend/cible et constate que la taille totale des en-têtes est supérieure à 25 Ko, il s'arrête et génère l'erreur :

      response headers size exceeding 25,600

      Cela implique que la taille totale de l'en-tête est supérieure à 25 Ko et qu'Apigee génère l'erreur lorsque la taille commence à dépasser la limite de 25 Ko avec le code d'erreur comme protocol.http.TooBigHeaders

Solution

Limites

Apigee s'attend à ce que l'application cliente et le serveur backend n'envoient pas de tailles d'en-tête supérieures à la limite autorisée, comme indiqué pour la taille de l'en-tête de requête/réponse dans la section Limites d'Apigee Edge.

1. Si vous êtes un utilisateur de Public Cloud, la limite maximale pour la taille des en-têtes de requête et de réponse est celle indiquée pour la taille de l'en-tête de requête/réponse dans la section Limites d'Apigee Edge.
2. Si vous êtes un utilisateur de Private Cloud, vous avez peut-être modifié la limite maximale par défaut pour la taille des en-têtes de requête et de réponse (même si ce n'est pas une pratique recommandée). Vous pouvez déterminer la limite maximale de taille des en-têtes de réponse en suivant les instructions de la section Comment vérifier la limite actuelle ?.

Comment vérifier la limite actuelle ?

Cette section explique comment vérifier que la propriété HTTPResponse.headers.limit a été mise à jour avec une nouvelle valeur sur les processeurs de messages.

1. Sur la machine du processeur de messages, recherchez la propriété HTTPResponse.headers.limit dans le répertoire /opt/apigee/edge-message-processor/conf et vérifiez la valeur définie, comme illustré ci-dessous :

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

2. L'exemple de résultat de la commande ci-dessus est le suivant :

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

3. Dans l'exemple de résultat ci-dessus, notez que la propriété HTTPResponse.headers.limit a été définie avec la valeur 25k dans http.properties.

   Cela indique que la limite de taille de la charge utile de la réponse configurée dans Apigee pour Private Cloud est de 25 Ko.

Si vous avez encore besoin de l'assistance de l'assistance Apigee, consultez la section Vous devez collecter des informations de diagnostic.

Vous devez collecter des informations de diagnostic

Rassemblez les informations de diagnostic suivantes, puis contactez l'assistance Apigee Edge :

Si vous êtes un utilisateur de Public Cloud, fournissez les informations suivantes :

• Nom de l'organisation
• Nom de l'environnement
• Nom du proxy d'API
• Commande curl complète utilisée pour reproduire l'erreur 502
• Fichier de trace pour les requêtes API
• Résultat complet de la réponse du serveur cible/backend, ainsi que la taille des en-têtes

Si vous êtes un utilisateur de Private Cloud, fournissez les informations suivantes :

• Message d'erreur complet observé pour les requêtes ayant échoué
• Nom de l'organisation
• Nom de l'environnement
• Bundle de proxy d'API
• Fichier de trace pour les requêtes API ayant échoué
• Commande curl complète utilisée pour reproduire l'erreur 502
• Résultat complet de la réponse du serveur cible/backend, ainsi que la taille des en-têtes

• Journaux d'accès NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Où : ORG, ENV et PORT# sont remplacés par des valeurs réelles.

• Journaux système du processeur de messages /opt/apigee/var/log/edge-message-processor/logs/system.log