502 Bad Gateway – DecompressionFailureAtResponse

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Problème constaté

L'application cliente obtient un code d'état HTTP 502 Bad Gateway avec le code d'erreur messaging.adaptors.http.flow.DecompressionFailureAtResponse en réponse à des 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, un message d'erreur semblable à celui présenté ci-dessous peut s'afficher:

{
   "fault":{
      "faultstring":"Decompression failure at response",
      "detail":{
         "errorcode":"messaging.adaptors.http.flow.DecompressionFailureAtResponse"
      }
   }
}

Causes possibles

Cette erreur ne se produit que dans les cas suivants :

• L'encodage spécifié dans l'en-tête de réponse HTTP (à partir du serveur backend/cible) Content-Encoding est valide et compatible avec Apigee Edge.

MAIS

• Le format de la charge utile envoyé par le serveur backend/cible dans le cadre de la réponse HTTP ne correspond pas au format d'encodage spécifié dans l'en-tête Content-Encoding .

En effet, Apigee Edge ne parvient pas à décoder la charge utile à l'aide de l'encodage spécifié, car le format de la charge utile n'est pas au même format que celui spécifié dans l'en-tête Content-Encoding.

Voici quelques exemples de valeurs Content-Encoding acceptées et la manière dont Apigee Edge s'attend à ce que la représentation de la charge utile soit dans ces cas:

Scénario	Content-Encoding	Représentation de la charge utile
Encodage unique	gzip	Format Unix gzip. Consultez la section Format GZIP RFC1952.
Encodage unique	dégonfler	Ce format utilise une structure zlib avec un algorithme de compression "Deflate". Voir les documents RFC 1950 et RFC 1951.
Encodage multiple	Encodage multiple Par exemple, si l'encodage est effectué deux fois, voici les possibilités qui s'offrent à vous: gzip, dégonfler gzip et gzip deflate, gzip dégonfler, dégonfler	Encodage multiple appliqué à la charge utile dans l'ordre donné, tel qu'il apparaît dans l'en-tête.

Causes possibles de cette erreur:

Cause	Description	Instructions de dépannage applicables
Le format de la charge utile de la réponse ne correspond pas à Content-Encoding	Le format de la charge utile de réponse envoyée par le serveur backend/cible n'est pas encodé ou ne correspond pas à l'encodage spécifié dans l'en-tête Content-Encoding.	Utilisateurs Edge Public and Private Cloud

Étapes de diagnostic courantes

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

Cause: le format de la charge utile de la réponse ne correspond pas à Content-Encoding

Par défaut, Apigee Edge décompresse toujours la charge utile si l'en-tête de réponse Content-Encoding contient un encodage compatible valide. Par conséquent, il est normal que le format de la charge utile de réponse correspond à l'encodage spécifié dans l'en-tête de réponse Content-Encoding. Si ce n'est pas le cas, ce message d'erreur s'affiche.

Diagnostic

1. Déterminez le code d'erreur et la source de l'erreur de 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 le code d'erreur est messaging.adaptors.http.flow.DecompressionFailureAtResponse et que la source d'erreur a la valeur target, cela indique que le format de la charge utile de réponse envoyée par le serveur backend/cible ne correspond pas à l' encodage compatible spécifié dans l'en-tête de réponse Content-Encoding.

3. Vous pouvez déterminer la non-concordance dans la réponse HTTP en utilisant l'une des méthodes suivantes:

   Message d'erreur

   Pour valider à l'aide du message d'erreur:

   1. Si vous avez accès au message d'erreur complet reçu d'Apigee Edge, reportez-vous au faultstring.

      Exemple de message d'erreur:

      "faultstring":"Decompression failure at response"
      

   2. Dans le message d'erreur ci-dessus, "Decompression failure at response" s'affiche, ce qui implique que la réponse n'a pas pu être décompressée à l'aide de l'encodage spécifié dans l'en-tête Content-Encoding.

   Trace

   Pour valider à l'aide de Trace:

   1. Déterminez les valeurs Content-Type et error.cause à l'aide de Trace, comme expliqué dans la section Étapes de diagnostic courantes.

   2. Les valeurs de l'exemple de trace sont les suivantes:

      • Content-Encoding:gzip
      • error.cause::Not in GZIP format

      La valeur de l'en-tête de réponse Content-Encoding est gzip. Cependant, la charge utile de la réponse n'est pas au format GZIP (comme indiqué par error.cause). Par conséquent, Apigee Edge répond avec 502 Bad Gateway et le code d'erreur messaging.adaptors.http.flow.DecompressionFailureAtResponse.

   Demande réelle

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

   Si vous avez accès à la requête réelle envoyée à l'application du serveur cible/backend, procédez comme suit:

   1. Si vous êtes un utilisateur de cloud public/cloud privé, envoyez 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é à envoyer la requête au serveur backend.
   2. Si vous êtes un utilisateur du cloud privé, vous pouvez également envoyer la requête au serveur backend à partir de l'un des processeurs de messages.
   3. Examiner la réponse envoyée par le serveur backend et déterminer la valeur transmise dans l'en-tête de réponse Content-Encoding.
   4. Déterminez le format de la charge utile envoyée dans le cadre de la requête.
   5. Si la valeur de l'en-tête Content-Encoding figure dans la liste des encodages compatibles, mais que le format de la charge utile de la réponse ne correspond pas à l'encodage spécifié dans l'en-tête Content-Encoding, c'est la cause du problème.

      Exemple:

      curl -v https://HOSTALIAS/test
      

      ***trimmed***
      >
      < HTTP/1.1 200 OK
      < Accept-Ranges: bytes
      < Content-Encoding: gzip
      < Date: Mon, 02 Aug 2021 08:17:35 GMT
      < Transfer-Encoding: chunked
      <
      < response_payload.zip Response Body(not in GZIP format)>
      

      L'exemple de réponse ci-dessus envoie la valeur gzip à l'en-tête Content-Encoding, qui est un encodage compatible dans Apigee Edge. Cependant, le response_payload.zip est envoyé sous forme de fichier ZIP. Par conséquent, cette réponse échoue avec une erreur 502 Bad Gateway avec le code d'erreur suivant : messaging.adaptors.http.flow.DecompressionFailureAtResponse.

   Journaux du processeur de messages

   Pour valider à 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 déterminer les informations clés sur les erreurs HTTP 502.

   1. Consultez le journal du processeur de messages:

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

   2. Recherchez s'il existe des erreurs 502 pendant une durée spécifique (si le problème s'est déjà produit par le passé) ou si des réponses échouent toujours avec 502. Vous pouvez utiliser la chaîne de recherche suivante:

      grep -ri "ZipException"
      

   3. Vous trouverez des lignes du fichier system.log semblables à ce qui suit:

      Scénario 1

      Scénario 1: lorsque la réponse de l'API comporte l'en-tête Content-Encoding: gzip

      2021-08-02 06:50:25,433  NIOThread@2 ERROR HTTP.CLIENT -
      HTTPClient$Context.onInputException() :  ClientInputChannel(ClientChannel[Connected:
      Remote:3.8.1.1:9000 Local:10.0.115.32:41298]@38140 useCount=1 bytesRead=0
      bytesWritten=203 age=469ms  lastIO=0ms  isOpen=true).onExceptionRead exception: {}
      java.util.zip.ZipException: Not in GZIP format
      ---trimmed--
      2021-08-02 06:50:25,433  NIOThread@2 INFO  HTTP.CLIENT -
      HTTPClient$Context.logContextDetails() : Request details : host=null
      path=/folder/testFile method=GET. Channel details : Bytes read=0
      2021-08-02 06:50:25,434  NIOThread@2 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError(HTTPResponse@4806fdab, Not in GZIP format)
      2021-08-02 06:50:25,434  NIOThread@2 INFO  HTTP.SERVICE -
      ExceptionHandler.handleException() : Exception
      java.util.zip.ZipException: Not in GZIP format
      occurred while writing to channel null
      2021-08-02 06:50:25,434  NIOThread@2 INFO  HTTP.SERVICE -
      ExceptionHandler.handleException() : Exception trace:
      java.util.zip.ZipException: Not in GZIP format
      

      La ligne java.util.zip.ZipException: Not in GZIP format dans le message d'erreur ci-dessus indique que la charge utile de la réponse n'est pas envoyée au format GZIP alors que Content-Encoding est spécifié comme gzip. Par conséquent, Apigee Edge génère l'exception et renvoie un code d'état 502 avec le code d'erreur messaging.adaptors.http.flow.DecompressionFailureAtResponse aux applications clientes.

      Scénario 2

      Scénario 2: lorsque la réponse de l'API comporte l'en-tête Content-Encoding: deflate

      2021-08-02 06:35:21,215  NIOThread@0 ERROR HTTP.CLIENT -
      HTTPClient$Context.onInputException() :  ClientInputChannel(ClientChannel[Connected:
      Remote:3.8.1.1:9000 Local:192.168.194.140:35224]@36014 useCount=1 bytesRead=0
      bytesWritten=202 age=439ms  lastIO=2ms  isOpen=true).onExceptionRead exception: {}
      java.util.zip.ZipException: incorrect header check
      ---trimmed----
      Caused by:
      java.util.zip.DataFormatException: incorrect header check
      ---trimmed---
      2021-08-02 06:35:21,215  NIOThread@0 INFO  HTTP.CLIENT -
      HTTPClient$Context.logContextDetails() : Request details :
      host=null path=/folder/testFile method=GET. Channel details : Bytes read=0
      2021-08-02 06:35:21,216  NIOThread@0 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError(HTTPResponse@3966e277,
      incorrect header check)
      2021-08-02 06:35:21,216  NIOThread@0 INFO  HTTP.SERVICE -
      ExceptionHandler.handleException() : Exception
      java.util.zip.ZipException: incorrect header check occurred while writing to channel null
      2021-08-02 06:35:21,217  NIOThread@0 INFO  HTTP.SERVICE -
      ExceptionHandler.handleException() : Exception trace:
      java.util.zip.ZipException: incorrect header check
      
      

      Les lignes java.util.zip.ZipException: incorrect header check et Caused by: java.util.zip.DataFormatException: incorrect header check dans le message d'erreur ci-dessus indiquent que la charge utile de la réponse n'est pas envoyée au format déflate et ne correspond pas à l'encodage spécifié dans l'en-tête Content-Encoding de déflate. Par conséquent, Apigee Edge génère l'exception et renvoie un code d'état 502 avec le code d'erreur messaging.adaptors.http.flow.DecompressionFailureAtResponse aux applications clientes.

Résolution

1. Si la charge utile de réponse compressée n'est pas nécessaire dans le flux de proxy d'API dans Apigee Edge et dans le serveur backend, ne transmettez pas l'en-tête Content-Encoding. Si vous devez compresser la charge utile de la réponse, passez à l'étape 2.
2. S'il est nécessaire de compresser la charge utile de réponse, assurez-vous que le serveur backend envoie toujours les éléments suivants :
   • N'importe quel encodage compatible en tant que valeur de l'en-tête Content-Encoding dans la réponse
   • La charge utile de réponse au format accepté par Apigee Edge correspond au format d'encodage spécifié dans l'en-tête Content-Encoding
3. Dans l'exemple décrit ci-dessus, la charge utile de la réponse est au format ZIP, mais l'en-tête de réponse spécifie Content-Encoding: gzip. Pour résoudre le problème, envoyez l'en-tête de réponse en tant que Content-Encoding: gzip et la charge utile de la réponse au format gzip :

   curl -v https://HOSTALIAS/v1/test
   

   >
   < HTTP/1.1 200 OK
   < Accept-Ranges: bytes
   < Content-Encoding: gzip
   < Date: Mon, 02 Aug 2021 08:17:35 GMT
   < Transfer-Encoding: chunked
   <
   < response_payload.gz Response Body(in GZIP format)>
   

Spécification

Apigee Edge renvoie le code d'état 502 Bad Gateway avec le code d'erreur messaging.adaptors.http.flow.DecompressionFailureAtResponse, conformément aux spécifications RFC suivantes:

Spécification
RFC 7231, section 6.5.1
RFC 7231, section 3.1.2.2

Si vous avez encore besoin de l'aide de l'assistance Apigee, consultez Vous devez recueillir 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 cloud public, fournissez les informations suivantes:

• Le nom de l'organisation.
• Nom de l'environnement
• Nom du proxy d'API
• Complétez la commande curl permettant de reproduire l'erreur 502.
• Fichier de suivi des réponses de l'API

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

• Message d'erreur complet observé pour les réponses en échec
• Nom de l'environnement
• Groupe de proxys d'API
• Fichier de suivi des réponses de l'API

• 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