502 Bad Gateway – TooBigLine

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

En outre, le message d'erreur suivant peut s'afficher :

{
   "fault":{
      "faultstring":"response line size exceeding 2,048",
      "detail":{
         "errorcode":"protocol.http.TooBigLine"
      }
   }
}

Causes possibles

Cette erreur se produit si la taille de la ligne de réponse envoyée par le serveur cible/backend à Apigee Edge dans le cadre de la réponse HTTP est supérieure à la limite maximale autorisée dans Apigee Edge.

Avant d'examiner les causes possibles de cette erreur, comprenons ce que signifie la ligne de réponse et comment vérifier sa taille.

Comprendre la ligne de réponse

Une réponse HTTP typique comporte trois parties :

1. Ligne d'état (appelée ligne de réponse dans Apigee)
2. ( Ensemble d'en-têtes HTTP )
3. [ Corps ]

La ligne de réponse comporte trois parties : la version du protocole, suivie d'un code d'état numérique et de sa phrase textuelle associée, comme illustré ci-dessous :

Response-Line   = <HTTP-Version> <Status-Code> <Reason-Phrase>

Lorsqu'une réponse HTTP est envoyée par l'application serveur cible/backend, la première ligne qui est envoyée représente la ligne de réponse , comme décrit ci-dessus. Elle est suivie des en-têtes et du corps/de la charge utile de la réponse.L'exemple de capture d'écran suivant montre une requête curl typique, la partie Request (Requête) et la partie Response (Réponse) (ainsi que la ligne de réponse).

Comprendre la taille de la ligne de réponse

1. Dans l'exemple ci-dessus, la ligne de début (première ligne) de la réponse, également appelée ligne de réponse , est la suivante :

   HTTP/1.1 200 OK

   Cette ligne de réponse a une taille d'environ ~15 bytes, car elle contient 15 ASCII characters. Comme cette taille est inférieure à la limite autorisée dans Apigee Edge, la réponse est renvoyée au client sans erreur par Apigee Edge.

2. De même, si vous examinez le faultstring dans le message d'erreur affiché ci-dessus, il contient "response line size exceeding 2,048". Cela indique que la ligne de réponse dans la réponse HTTP envoyée par le serveur cible/backend a dépassé 2 048 octets.

Comprendre les lignes de réponse volumineuses

Conformément à la définition de la ligne d'état (appelée ligne de réponse ici) et aux requêtes et réponses HTTP typiques, la taille est beaucoup plus petite que la limite par défaut définie de 2 Ko dans Apigee Edge. Il est donc possible que nous n'atteignions pas la limite. Toutefois, voici quelques scénarios possibles dans lesquels vous pouvez dépasser cette limite :

1. Le serveur cible/backend n'est pas un système HTTP. Il peut répondre avec une réponse non HTTP réponse.
2. Le serveur cible/backend rencontre des problèmes et envoie une longue ligne de réponse dans le cadre de la réponse HTTP réponse.

Pour en savoir plus, consultez la section Erreur d'obtention du protocole.http.TooBigLine, "response line size exceeding 2,048.

Voici les causes possibles de l'erreur :

Étapes de diagnostic courantes

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

Cause : La taille de la ligne de réponse est supérieure à la limite autorisée

Diagnostic

1. Déterminez le code d'erreur et la source de l'erreur 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 la section Étapes de diagnostic courantes.
2. Si la source de l'erreur a la valeur target, cela indique que la taille de la ligne de réponse envoyée par l'application serveur cible/backend à Apigee est supérieure à la limite autorisée dans Apigee Edge.

3. Vous pouvez vérifier que la taille de la ligne de réponse a dépassé la limite autorisée de 2 Ko à 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, reportez-vous à faultstring.

   Exemple de message d'erreur :

   "faultstring":"response line size exceeding 2,048"

   Le faultstring ci-dessus indique que la taille de la ligne de réponse a dépassé la limite autorisée de 2 Ko.

   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 à l'application serveur cible/backend, procédez comme suit :

   1. Vérifiez la taille de la ligne de réponse.
   2. Si vous constatez que la taille de l'URI 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/backend :

      curl -v http://HOSTALIAS/test
      

      *   Trying 3.2.1.4...
      * TCP_NODELAY set
      * Connected to <hostalias> (3.2.1.4) port 80 (#0)
      > GET /test HTTP/1.1
      > Host: HOSTALIAS
      > User-Agent: curl/7.64.1
      > Accept: */*
      >
      < HTTP/1.1 200 1111…<trimmed>...11111111
      < Date: Mon, 26 Jul 2021 07:07:18 GMT
      < Content-Type: application/json
      < Content-Length: 269
      < Connection: keep-alive
      < Server: gunicorn/19.9.0
      < Access-Control-Allow-Origin: *
      < Access-Control-Allow-Credentials: true
      <
      {
      <Response Body>
      }
      * Connection #0 to host <hostalias> left intact
      * Closing connection 0

      Dans le cas ci-dessus, la ligne de réponse HTTP/1.1 200 1111…<trimmed>...11111111 est supérieure à 2 Ko, c'est-à-dire qu'elle contient plus de 2 000 caractères ASCII.

      Si vous utilisez un autre client, vous pouvez consulter les journaux du client et essayer de déterminer la taille de la ligne de réponse envoyée à Apigee Edge.

   Journaux du processeur de messages

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

   Si vous êtes un utilisateur du cloud privé, vous pouvez utiliser les journaux du processeur de messages pour vérifier si la taille de la ligne de réponse a dépassé la limite autorisée dans Apigee Edge.

   1. Déterminez l'ID de message de la requête ayant échoué à l'aide de la surveillance des API, de l'outil Trace, ou des journaux d'accès NGINX, comme expliqué dans la section Étapes de diagnostic courantes.

   2. Recherchez l'ID de message dans le journal du processeur de messages :

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

   3. Vous trouverez des lignes de system.log semblables à celles-ci :

      2021-07-26 06:45:41,451 org:myorg env:prod api:testtoobigline rev:1 messageid:r-5110240-1
      NIOThread@1 ERROR HTTP.CLIENT - HTTPClient$Context$3.onException() :
      ClientChannel[Connected: Remote:3.2.1.2:80 Local:192.168.205.251:44398]@20592
      useCount=1 bytesRead=0 bytesWritten=201 age=144ms  lastIO=0ms  isOpen=true.onExceptionRead
      exception: {}
      com.apigee.errors.http.server.BadGateway: response line size exceeding 2,048
      at <snipped>
      
      2021-07-26 06:45:41,451 org:myorg env:prod api:testtoobigline rev:1
      messageid:r-5110240-1  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError
      (HTTPResponse@6a5d6c33, response line size exceeding 2,048)

      Le texte message = response line size exceeding 2,048 dans le message d'erreur ci-dessus indique que la taille de la ligne de réponse est supérieure à 2 Ko. Par conséquent, Apigee Edge génère l'exception et renvoie un code d'état 502 avec code d'erreur protocol.http.TooBigline aux applications clientes.

Solution

Limites

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

1. Si vous êtes un utilisateur du cloud public, la limite maximale pour la taille de la ligne de requête et de réponse est celle indiquée pour la taille de la ligne de requête/réponse dans la section Limites d'Apigee Edge.
2. Si vous êtes un utilisateur du cloud privé, vous avez peut-être modifié la limite maximale par défaut pour la taille de la ligne 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 la taille de la ligne 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.line.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.line.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.line.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.line.limit=2k

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

   Cela indique que la limite de taille de la ligne de réponse configurée dans Apigee pour le cloud privé est de 2 Ko.

Si vous avez encore besoin d'aide de la part 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 du cloud public, 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

Si vous êtes un utilisateur du cloud privé, 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

• 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