502 Gateway Buruk - DekompresiFailureAtResponse

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Gejala

Aplikasi klien mendapatkan kode status HTTP 502 Bad Gateway dengan kode error messaging.adaptors.http.flow.DecompressionFailureAtResponse sebagai respons terhadap panggilan API.

Pesan error

Aplikasi klien mendapatkan kode respons berikut:

HTTP/1.1 502 Bad Gateway

Selain itu, Anda mungkin melihat pesan error yang mirip dengan yang ditunjukkan di bawah ini:

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

Kemungkinan penyebab

Error ini hanya terjadi jika:

• Encoding yang ditentukan dalam header respons HTTP (dari server backend/target) Content-Encoding valid dan didukung oleh Apigee Edge,

TETAPI

• Format payload yang dikirim oleh server backend/target sebagai bagian dari respons HTTP tidak cocok dengan format encoding yang ditentukan di header Content-Encoding

Hal ini karena Apigee Edge gagal mendekode payload menggunakan encoding yang ditentukan karena format payload tidak sama dengan format encoding yang ditentukan di header Content-Encoding.

Berikut beberapa contoh nilai Content-Encoding yang didukung dan cara Apigee Edge mengharapkan representasi payload dalam kasus tersebut:

Kemungkinan penyebab error ini adalah sebagai berikut:

Langkah-langkah diagnosis umum

Gunakan salah satu alat/teknik berikut untuk mendiagnosis error ini:

Penyebab: Format payload respons tidak cocok dengan Content-Encoding

Secara default, Apigee Edge selalu mendekompresi payload jika header respons Content-Encoding berisi encoding yang valid dan didukung. Oleh karena itu, format payload respons harus cocok dengan encoding yang ditentukan di header respons Content-Encoding. Jika ada ketidakcocokan, Anda akan mendapatkan error ini.

Diagnosis

1. Tentukan Kode Kesalahan dan Sumber Kesalahan untuk error yang diamati menggunakan Pemantauan API, alat Trace, atau log akses NGINX seperti yang dijelaskan dalam Langkah-langkah diagnosis umum.
2. Jika Fault Code adalah messaging.adaptors.http.flow.DecompressionFailureAtResponse dan Fault Source memiliki nilai target, maka hal ini menunjukkan bahwa format payload respons yang dikirim oleh server backend/target tidak cocok dengan encoding yang didukung yang ditentukan di header respons Content-Encoding.

3. Anda dapat menentukan ketidakcocokan sebagai bagian dari respons HTTP menggunakan salah satu metode berikut:

   Pesan error

   Untuk memvalidasi menggunakan pesan error:

   1. Jika Anda memiliki akses ke pesan error lengkap yang diterima dari Apigee Edge, maka lihat faultstring.

      Contoh pesan error:

      "faultstring":"Decompression failure at response"

   2. Dalam pesan error di atas, "Decompression failure at response" ditampilkan, yang menyiratkan bahwa respons tidak dapat didekompresi menggunakan encoding yang ditentukan di header Content-Encoding.

   Trace

   Untuk memvalidasi menggunakan Trace:

   1. Tentukan Content-Type dan error.cause menggunakan Trace seperti yang dijelaskan dalam Langkah-langkah diagnosis umum.

   2. Nilai dari rekaman aktivitas sampel adalah sebagai berikut:

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

      Nilai di header respons Content-Encoding adalah gzip; namun, payload respons tidak dalam format GZIP (seperti yang ditunjukkan oleh error.cause). Oleh karena itu, Apigee Edge merespons dengan 502 Bad Gateway dan kode error messaging.adaptors.http.flow.DecompressionFailureAtResponse.

   Permintaan sebenarnya

   Untuk memvalidasi menggunakan permintaan sebenarnya:

   Jika Anda memiliki akses ke permintaan sebenarnya yang dibuat ke aplikasi server target/backend, lakukan langkah-langkah berikut:

   1. Jika Anda adalah pengguna Cloud Publik/Cloud Pribadi, buat permintaan langsung ke server backend dari server backend itu sendiri atau mesin lain tempat Anda diizinkan untuk membuat permintaan ke server backend.
   2. Jika Anda adalah pengguna Private Cloud, Anda juga dapat membuat permintaan ke server backend dari salah satu Pemroses Pesan.
   3. Periksa respons yang dikirim oleh server backend dan tentukan nilai yang diteruskan di header respons Content-Encoding.
   4. Tentukan format payload yang dikirim sebagai bagian dari permintaan.
   5. Jika nilai header Content-Encoding ada dalam daftar encoding yang didukung, tetapi format payload respons tidak cocok dengan encoding yang ditentukan dalam header Content-Encoding, maka itulah penyebab masalahnya.

      Contoh:

      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)>
      

      Respons contoh di atas mengirimkan nilai gzip ke header Content-Encoding yang merupakan encoding yang didukung di Apigee Edge. Namun, response_payload.zip dikirim sebagai file zip. Oleh karena itu, respons ini gagal dengan error 502 Bad Gateway dengan kode error: messaging.adaptors.http.flow.DecompressionFailureAtResponse.

   Log Message Processor

   Untuk memvalidasi menggunakan log Message Processor:

   Jika Anda adalah pengguna Private Cloud, Anda dapat menggunakan log Message Processor untuk menentukan informasi utama tentang error HTTP 502.

   1. Periksa log Message Processor:

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

   2. Lakukan penelusuran untuk melihat apakah ada error 502 selama durasi tertentu (jika masalah terjadi di masa lalu) atau apakah ada respons yang masih gagal dengan 502. Anda dapat menggunakan string penelusuran berikut:

      grep -ri "ZipException"
      

   3. Anda akan menemukan baris dari system.log yang mirip dengan berikut ini:

      Skenario #1

      Skenario #1: Saat respons API memiliki header 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
      

      Baris java.util.zip.ZipException: Not in GZIP format dalam pesan error di atas menunjukkan bahwa payload respons tidak dikirim dalam format GZIP meskipun Content-Encoding ditentukan sebagai gzip. Oleh karena itu, Apigee Edge akan memunculkan pengecualian dan menampilkan kode status 502 dengan kode kesalahan messaging.adaptors.http.flow.DecompressionFailureAtResponse ke aplikasi klien.

      Skenario #2

      Skenario #2: Saat respons API memiliki header 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
      
      

      Baris java.util.zip.ZipException: incorrect header check dan Caused by: java.util.zip.DataFormatException: incorrect header check dalam pesan error di atas menunjukkan bahwa payload respons tidak dikirim dalam format deflate dan tidak cocok dengan encoding yang ditentukan di header Content-Encoding deflate. Oleh karena itu, Apigee Edge akan memunculkan pengecualian dan menampilkan kode status 502 dengan kode kesalahan messaging.adaptors.http.flow.DecompressionFailureAtResponse ke aplikasi klien.

Resolusi

1. Jika tidak ada kebutuhan untuk payload respons yang dikompresi dalam alur proxy API di Apigee Edge dan di server backend, maka jangan teruskan header Content-Encoding. Jika ada kebutuhan untuk memadatkan payload respons, lanjutkan ke langkah 2.
2. Jika ada kebutuhan untuk mengompresi payload respons, pastikan server backend selalu mengirimkan hal berikut:
   • Salah satu encoding yang didukung sebagai nilai untuk header Content-Encoding dalam respons
   • Payload respons dalam format yang didukung ke Apigee Edge cocok dengan format encoding yang ditentukan di header Content-Encoding
3. Dalam contoh yang dibahas di atas, payload respons dalam format ZIP, tetapi header respons menentukan Content-Encoding: gzip. Anda dapat memperbaiki masalah ini dengan mengirim header respons sebagai Content-Encoding: gzip dan payload respons dalam 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)>
   

Spesifikasi

Apigee Edge merespons dengan kode status 502 Bad Gateway dengan kode error messaging.adaptors.http.flow.DecompressionFailureAtResponse sesuai dengan spesifikasi RFC berikut:

Jika Anda masih memerlukan bantuan dari Dukungan Apigee, buka Mengumpulkan informasi diagnostik.

Harus mengumpulkan informasi diagnostik

Kumpulkan informasi diagnostik berikut, lalu hubungi Dukungan Apigee Edge:

Jika Anda adalah pengguna Cloud Publik, berikan informasi berikut:

• Nama organisasi
• Nama lingkungan
• Nama Proxy API
• Perintah curl lengkap yang digunakan untuk memunculkan kembali error 502
• File rekaman aktivitas untuk respons API

Jika Anda adalah pengguna Private Cloud, berikan informasi berikut:

• Pesan error lengkap yang diamati untuk respons yang gagal
• Nama lingkungan
• Paket Proxy API
• File rekaman aktivitas untuk respons API

• Log akses NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Tempat: ORG, ENV, dan PORT# diganti dengan nilai sebenarnya.

• Log sistem Message Processor /opt/apigee/var/log/edge-message-processor/logs/system.log