502 Gateway Buruk - TooBigLine

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.TooBigLine 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 line size exceeding 2,048",
      "detail":{
         "errorcode":"protocol.http.TooBigLine"
      }
   }
}

Kemungkinan penyebab

Error ini terjadi jika ukuran Response-Line yang dikirim oleh server target/backend ke Apigee Edge sebagai bagian dari respons HTTP lebih besar daripada batas maksimum yang diizinkan di Apigee Edge.

Sebelum melihat kemungkinan penyebab error ini, mari kita pahami arti Respons-Baris dan cara memeriksa ukurannya.

Memahami Baris Respons

Respons HTTP umumnya terdiri dari tiga bagian:

1. Status-Line (Dirujuk sebagai Response-Line di Apigee)
2. ( Kumpulan tajuk HTTP )
3. [ Badan ]

Respons-Line terdiri dari tiga bagian: versi protokol yang diikuti dengan kode status numerik dan frasa tekstual terkait seperti yang ditunjukkan di bawah ini:

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

Jika respons HTTP dikirim oleh aplikasi server target/backend, baris pertama yang dikirim merepresentasikan Response-Line seperti yang dijelaskan di atas. Hal ini diikuti oleh header dan isi/payload respons.Screenshot contoh berikut menunjukkan permintaan curl standar, bagian Request, dan bagian Response (beserta Response-Line).

Memahami ukuran Baris Respons

1. Dalam contoh yang dibahas di atas, baris awal (baris pertama) dalam respons yang juga disebut sebagai Response-Line adalah sebagai berikut:

   HTTP/1.1 200 OK
   

   Baris Respons ini berukuran ~15 bytes karena berisi 15 ASCII characters. Karena hal ini berada dalam batas yang diizinkan di Apigee Edge, respons akan dikirim kembali ke klien tanpa error apa pun oleh Apigee Edge.

2. Demikian pula, jika Anda melihat faultstring dalam Pesan error yang ditampilkan di atas, pesan tersebut berisi "response line size exceeding 2,048". Hal ini menunjukkan bahwa Response-Line dalam respons HTTP yang dikirim oleh server target/backend melebihi 2.048 byte.

Memahami Baris Respons yang besar

Sesuai dengan definisi Status-Line (disebut Response-Line di sini) serta permintaan dan respons HTTP yang umum, ukurannya akan jauh lebih kecil daripada batas default yang ditentukan, yaitu 2 K di Apigee Edge, sehingga kita mungkin tidak mencapai batas. Namun, berikut ini beberapa kemungkinan skenario yang mungkin melebihi batas ini:

1. Server target/backend bukan sistem HTTP. URL tersebut dapat merespons dengan respons non-HTTP.
2. Server target/backend memiliki masalah dan mengirim Response-Line yang panjang sebagai bagian dari respons HTTP.

Baca selengkapnya tentang hal ini di Mendapatkan protokol error.http.TooBigLine, "ukuran baris respons melebihi 2.048.

Berikut kemungkinan penyebab error:

Penyebab	Deskripsi	Petunjuk pemecahan masalah yang berlaku untuk
Ukuran Respons-Line lebih besar dari batas yang diizinkan	Ukuran Response-Line yang dikirim oleh server target/backend sebagai bagian dari respons HTTP ke Apigee Edge lebih besar dari 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 Baris Respons lebih besar dari batas yang diizinkan

Diagnosis

1. Tentukan Kode Kesalahan dan Sumber Kesalahan untuk error yang diamati menggunakan Pemantauan API, Alat Pelacakan, atau log akses NGINX seperti yang dijelaskan dalam Langkah-langkah diagnosis umum.
2. Jika Fault Source memiliki nilai target, ini menunjukkan bahwa ukuran Response-Line yang dikirim oleh aplikasi server target/backend ke Apigee lebih besar daripada batas yang diizinkan di Apigee Edge.

3. Anda dapat memvalidasi bahwa ukuran Respons-Line telah melampaui batas yang diizinkan sebesar 2 KB 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.

   Contoh pesan error:

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

   faultstring di atas menunjukkan bahwa ukuran Respons-Line melampaui batas yang diizinkan, yaitu 2 KB.

   Permintaan sebenarnya

   Untuk memvalidasi menggunakan permintaan yang sebenarnya:

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

   1. Memverifikasi ukuran Response-Line
   2. Jika Anda menemukan bahwa ukuran URI melebihi batas yang diizinkan di Apigee Edge, maka itulah yang menyebabkan masalah tersebut.

      Contoh respons dari server target/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
      

      Dalam kasus di atas, HTTP/1.1 200 1111…<trimmed>...11111111 Response-Line lebih besar dari 2 KB, yaitu berisi lebih dari 2 karakter K ASCII.

      Jika menggunakan beberapa klien lain, Anda dapat meninjau log klien dan mencoba mengetahui ukuran Response-Line yang dikirim ke Apigee Edge.

   Log Pemroses Pesan

   Untuk memvalidasi menggunakan log Pemroses Pesan:

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

   1. Tentukan ID pesan dari permintaan yang gagal menggunakan Pemantauan API, Alat Pelacakan, atau log akses NGINX seperti yang dijelaskan dalam Langkah-langkah diagnosis umum.

   2. Telusuri ID pesan di log Message Processor:

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

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

      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)
      

      Teks message = response line size exceeding 2,048 pada pesan error di atas menunjukkan bahwa ukuran Respons-Line lebih dari 2 KB. Oleh karena itu, Apigee Edge menampilkan pengecualian dan menampilkan kode status 502 dengan kode kesalahan protocol.http.TooBigline ke aplikasi klien.

Resolusi

Batas

Apigee memperkirakan aplikasi klien dan server backend tidak akan mengirim Request/Response-Lines yang ukurannya melebihi batas yang diizinkan seperti yang didokumentasikan untuk Request/Response Line Limit dalam Apigee Edge Limits.

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

Bagaimana cara memeriksa batas saat ini?

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

1. Pada mesin Message Processor, telusuri properti HTTPResponse.line.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.line.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.line.limit=2k
   

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

   Hal ini menunjukkan bahwa batas ukuran Respons-Line yang dikonfigurasi di Apigee untuk Private Cloud adalah 2 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
• Perintah curl lengkap yang digunakan untuk mereproduksi error 502
• File rekaman aktivitas untuk permintaan API

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

• 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