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 kita melihat kemungkinan penyebab error ini, mari kita pahami apa yang dimaksud dengan Response-Line dan cara memeriksa ukurannya.

Memahami Response-Line

Respons HTTP biasanya terdiri dari tiga bagian:

1. Status-Line (Disebut sebagai Response-Line di Apigee)
2. ( Set header HTTP )
3. [ Body ]

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

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

Saat respons HTTP dikirim oleh aplikasi server target/backend, baris pertama yang dikirimkan mewakili Response-Line seperti yang dijelaskan di atas. Ini diikuti dengan header dan isi/payload respons.Screenshot contoh berikut menunjukkan permintaan curl yang umum, bagian Request, dan bagian Response (bersama dengan Response-Line).

Memahami ukuran Response-Line

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

   HTTP/1.1 200 OK

   Garis Respons ini memiliki ukuran ~15 bytes karena berisi 15 ASCII characters. Karena masih dalam batas yang diizinkan di Apigee Edge, respons dikirim kembali ke klien tanpa error apa pun oleh Apigee Edge.

2. Demikian pula, jika Anda melihat faultstring di 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 Response-Line besar

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

1. Server target/backend bukan sistem HTTP. Aplikasi dapat merespons dengan respons non-HTTP.
2. Server target/backend mengalami masalah dan mengirimkan Baris-Respons yang panjang sebagai bagian dari respons HTTP.

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

Berikut kemungkinan penyebab error:

Langkah-langkah diagnosis umum

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

Penyebab: Ukuran Response-Line lebih besar dari batas yang diizinkan

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 Source memiliki nilai target, maka hal 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 Response-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 Response-Line melebihi batas yang diizinkan, yaitu 2 KB.

   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. Verifikasi ukuran Baris-Respons
   2. Jika Anda menemukan bahwa ukuran URI lebih besar dari batas yang diizinkan di Apigee Edge, maka itulah penyebab masalahnya.

      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, Response-Line HTTP/1.1 200 1111…<trimmed>...11111111 lebih besar dari 2 KB, yaitu berisi lebih dari 2 K karakter ASCII.

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

   Log Message Processor

   Untuk memvalidasi menggunakan log Message Processor:

   Jika Anda adalah pengguna Private Cloud, Anda dapat menggunakan log Message Processor untuk memvalidasi apakah ukuran Response-Line telah melampaui batas yang diizinkan di Apigee Edge.

   1. Tentukan ID pesan permintaan yang gagal menggunakan Pemantauan API, alat Trace, 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 dalam pesan error di atas menunjukkan bahwa ukuran Response-Line lebih dari 2 KB. Oleh karena itu, Apigee Edge akan memunculkan pengecualian dan menampilkan kode status 502 dengan kode kesalahan protocol.http.TooBigline ke aplikasi klien.

Resolusi

Batas

Apigee mengharapkan aplikasi klien dan server backend tidak mengirimkan Baris Permintaan/Respons yang ukurannya lebih besar dari batas yang diizinkan seperti yang didokumentasikan untuk Batas Baris Permintaan/Respons di Batas Apigee Edge.

1. Jika Anda adalah pengguna Public Cloud, batas maksimum untuk ukuran Baris Permintaan dan Respons adalah seperti yang didokumentasikan untuk ukuran Baris Permintaan/Respons di Batas Apigee Edge.
2. Jika Anda adalah pengguna Private Cloud, Anda mungkin telah mengubah batas maksimum default untuk ukuran Baris Permintaan dan Respons (meskipun bukan praktik yang direkomendasikan). Anda dapat menentukan batas ukuran Baris-Respons 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. Di mesin Message Processor, telusuri properti HTTPResponse.line.limit di direktori /opt/apigee/edge-message-processor/conf dan periksa untuk melihat nilai 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. Dalam contoh output di atas, perhatikan bahwa properti HTTPResponse.line.limit telah ditetapkan dengan nilai 2k di http.properties.

   Hal ini menunjukkan bahwa batas ukuran Response-Line yang dikonfigurasi di Apigee untuk Private Cloud adalah 2 KB.

Jika Anda masih memerlukan bantuan dari Dukungan Apigee, buka Must gather diagnostic information.

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 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
• Perintah curl lengkap yang digunakan untuk memunculkan kembali 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 Message Processor /opt/apigee/var/log/edge-message-processor/logs/system.log