502 Gateway Buruk - TooBigHeader

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

Gejala

Aplikasi klien mendapatkan kode status HTTP 502 Bad Gateway dengan kode error protocol.http.TooBigHeaders sebagai respons untuk panggilan API.

Pesan error

Aplikasi klien mendapatkan kode respons berikut:

HTTP/1.1 502 Bad Gateway

Selain itu, Anda mungkin melihat pesan error berikut:

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

Kemungkinan penyebab

Error ini terjadi jika ukuran total header yang dikirim oleh server target/backend ke Apigee Edge sebagai bagian dari respons HTTP lebih besar dari batas yang diizinkan di Apigee Edge.

Berikut kemungkinan penyebab error ini:

Penyebab	Deskripsi	Petunjuk pemecahan masalah yang berlaku untuk
Ukuran header dalam respons lebih besar dari batas yang diizinkan	Ukuran header header tertentu atau jumlah ukuran header dari semua header yang dikirim oleh server target/backend sebagai bagian dari respons HTTP terhadap Apigee Edge melebihi batas yang diizinkan di Apigee Edge.	Pengguna Edge Publik dan Private Cloud

Langkah-langkah diagnosis umum

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

Penyebab: Ukuran header dalam respons melebihi batas yang diizinkan

Diagnosis

1. Tentukan Fault Code, Fault Source, dan Response Payload Size untuk error yang diamati menggunakan API Monitoring, alat Trace, atau log Access NGINX seperti yang dijelaskan dalam Langkah-langkah diagnosis umum.
2. Jika Fault Source memiliki nilai target, hal ini menunjukkan bahwa respons yang dikirim oleh server target/backend ke Apigee memiliki header yang ukurannya lebih besar dari batas yang diizinkan di Apigee Edge.
3. Anda dapat memvalidasi bahwa respons dari target/backend memiliki header yang ukurannya lebih besar dari batas yang diizinkan menggunakan salah satu metode berikut:

   Pesan error

   Untuk memvalidasi menggunakan pesan error:

   Jika Anda memiliki akses ke pesan error lengkap yang diterima dari Apigee Edge, lihat faultstring. faultstring menunjukkan bahwa ukuran header respons telah melampaui batas yang diizinkan.

   Contoh pesan error:

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

   Pada pesan error di atas, perhatikan di faultstring bahwa respons memiliki header yang ukuran totalnya melebihi batas yang diizinkan.

   Permintaan sebenarnya

   Untuk memvalidasi menggunakan permintaan yang sebenarnya:

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

   1. Jika Anda adalah pengguna Cloud Publik/Private Cloud, 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 diterima dari server backend dan secara khusus hitung dan verifikasi total ukuran header yang diteruskan dalam respons.

   4. Jika Anda mendapati bahwa ukuran header dalam payload respons melebihi batas yang diizinkan di Apigee Edge, maka itulah penyebab masalahnya.

      Contoh respons dari server target:

      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
      

      Pada contoh di atas, Testheader1 dan Testheader2 memiliki ukuran yang lebih tinggi, yang menjadi penyebab error ini karena melampaui batas yang diizinkan di Apigee Edge.

   Log Pemroses Pesan

   Untuk memvalidasi menggunakan log Pemroses Pesan:

   Jika Anda adalah pengguna Private Cloud, Anda dapat menggunakan log Prosesor Pesan untuk memvalidasi apakah ukuran header Respons telah melampaui batas yang diizinkan di Apigee Edge.

   1. Periksa log Message Processor:

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

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

      grep -ri "response headers size exceeding"
      

   3. Anda akan menemukan baris dari system.log yang mirip dengan yang berikut ini. Ukuran header respons dapat bervariasi dalam kasus Anda:

      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. Segera setelah Pemroses Pesan menerima respons dari server backend/target dan menemukan bahwa ukuran total header lebih besar dari 25 KB, Pemroses Pesan akan berhenti dan menampilkan error:

      response headers size exceeding 25,600

      Ini menyiratkan bahwa Total Header Size lebih dari 25 KB dan Apigee akan menampilkan error ketika ukuran mulai melebihi batas 25 KB dengan kode kesalahan sebagai protocol.http.TooBigHeaders

Resolusi

Batas

Apigee memperkirakan bahwa aplikasi klien dan server backend tidak akan mengirim ukuran header lebih besar dari batas yang diizinkan seperti yang didokumentasikan untuk Ukuran Header Permintaan/Respons di Apigee Edge Limits.

1. Jika Anda adalah pengguna Cloud Publik, batas maksimum untuk ukuran header Permintaan dan Respons adalah seperti yang didokumentasikan untuk Ukuran Header Permintaan/Respons di Batas Apigee Edge.
2. Jika Anda adalah pengguna Private Cloud, Anda mungkin telah mengubah batas maksimum default untuk ukuran header Permintaan dan Respons (meskipun bukan praktik yang direkomendasikan). Anda dapat menentukan batas ukuran Header Respons maksimum dengan mengikuti petunjuk dalam Cara memeriksa batas saat ini.

Bagaimana cara memeriksa batas saat ini?

Bagian ini menjelaskan cara memverifikasi bahwa properti HTTPResponse.headers.limit telah diperbarui dengan nilai baru di Pemroses Pesan.

1. Pada mesin Message Processor, telusuri properti HTTPResponse.headers.limit dalam direktori /opt/apigee/edge-message-processor/conf, lalu periksa untuk melihat nilai apa yang telah ditetapkan seperti yang ditunjukkan di bawah:

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

2. Contoh hasil dari perintah di atas adalah sebagai berikut:

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

3. Pada contoh output di atas, perhatikan bahwa properti HTTPResponse.headers.limit telah ditetapkan dengan nilai 25k di http.properties.

   Hal ini menunjukkan bahwa batas ukuran payload Respons yang dikonfigurasi di Apigee untuk Private Cloud adalah 25 KB.

Jika Anda masih memerlukan bantuan dari Dukungan Apigee, buka Harus 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
• Selesaikan perintah curl yang digunakan untuk mereproduksi error 502
• File rekaman aktivitas untuk permintaan API
• Lengkapi output respons dari server target/backend beserta ukuran headernya

Jika Anda adalah pengguna Private Cloud, berikan informasi berikut:

• Pesan error lengkap yang diamati untuk permintaan yang gagal
• Nama organisasi
• Nama lingkungan
• Paket Proxy API
• File rekaman aktivitas untuk permintaan API yang gagal
• Selesaikan perintah curl yang digunakan untuk mereproduksi error 502
• Lengkapi output respons dari server target/backend beserta ukuran headernya

• 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 Pemroses Pesan /opt/apigee/var/log/edge-message-processor/logs/system.log