Layanan 503 Tidak Tersedia - Penutupan dini oleh server backend

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

Gejala

Aplikasi klien mendapatkan status respons HTTP 503 dengan pesan Service Unavailable setelah panggilan proxy API.

Pesan error

Aplikasi klien mendapatkan kode respons berikut:

HTTP/1.1 503 Service Unavailable

Selain itu, Anda mungkin melihat pesan error berikut:

{
   "fault": {
      "faultstring": "The Service is temporarily unavailable",
      "detail": {
           "errorcode": "messaging.adaptors.http.flow.ServiceUnavailable"
       }
    }
}

Kemungkinan Penyebab

Penyebab Deskripsi Petunjuk pemecahan masalah yang berlaku untuk
Server target menutup koneksi sebelum waktunya Server target mengakhiri koneksi sebelum waktunya saat Message Processor masih mengirim payload permintaan. Pengguna Edge Public dan Private Cloud

Langkah-langkah diagnosis umum

Menentukan ID Pesan dari permintaan yang gagal

Alat rekaman aktivitas

Untuk menentukan ID pesan permintaan yang gagal menggunakan alat Trace:

  1. Jika masalah masih aktif, aktifkan sesi rekaman aktivitas untuk API yang terpengaruh.
  2. Lakukan panggilan API dan reproduksi masalah - 503 Service Unavailable dengan kode error messaging.adaptors.http.flow.ServiceUnavailable.
  3. Pilih salah satu permintaan yang gagal.
  4. Buka fase AX, dan tentukan ID pesan (X-Apigee.Message-ID) permintaan dengan men-scroll ke bawah di bagian Detail Fase seperti yang ditunjukkan pada gambar berikut.

    ID Pesan di bagian Detail Fase

Log akses NGINX

Untuk menentukan ID pesan permintaan yang gagal menggunakan log akses NGINX:

Anda juga dapat merujuk ke log Akses NGINX untuk menentukan ID pesan untuk error 503. Hal ini sangat berguna jika masalah telah terjadi di masa lalu atau jika masalah bersifat tidak tetap dan Anda tidak dapat merekam rekaman aktivitas di UI. Gunakan langkah-langkah berikut untuk menentukan informasi ini dari log akses NGINX:

  1. Periksa log akses NGINX: (/opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log)
  2. Cari untuk melihat apakah ada 503Error untuk proxy API tertentu selama durasi tertentu (jika masalah terjadi di masa lalu) atau apakah ada permintaan yang masih gagal dengan 503.
  3. Jika ada Error 503 dengan X-Apigee-fault-code messaging.adaptors.http.flow.ServiceUnavailable, catat ID pesan untuk satu atau beberapa permintaan tersebut seperti yang ditunjukkan dalam contoh berikut:

    Contoh Entri yang menunjukkan Error 503

    Contoh entri yang menampilkan kode status, ID pesan, sumber kesalahan, dan kode kesalahan

Penyebab: Server target menutup koneksi sebelum waktunya

Diagnosis

  1. Jika Anda adalah pengguna Public Cloud atau Private Cloud:
    1. Gunakan alat Perekaman Aktivitas (seperti yang dijelaskan dalam Langkah-langkah diagnosis umum) dan pastikan Anda telah menetapkan kedua hal berikut di panel Data Analytics Direkam:
      • X-Apigee.fault-code: messaging.adaptors.http.flow.ServiceUnavailable
      • X-Apigee.fault-source: target

      alt_text

    2. Gunakan alat Trace (seperti yang dijelaskan dalam Langkah-langkah diagnosis umum) dan verifikasi bahwa Anda telah menetapkan kedua hal berikut di panel Error segera setelah properti state TARGET_REQ_FLOW:
      • error.class: com.apigee.errors.http.server.ServiceUnavailableException
      • error.cause: Broken pipe

      alt_text

    3. Buka Menggunakan tcpdump untuk penyelidikan lebih lanjut.
  2. Jika Anda adalah pengguna Private Cloud:
    • Tentukan ID pesan permintaan yang gagal.
    • Telusuri ID pesan di log Message Processor (/opt/apigee/var/log/edge-message-processor/logs/system.log).
    • Anda akan melihat salah satu pengecualian berikut:

      Pengecualian #1: java.io.IOException: Broken pipe occurred while writing to channel ClientOutputChannel

      2021-01-30 15:31:14,693 org:anotherorg env:prod api:myproxy
      rev:1 messageid:myorg-opdk-test-1-30312-13747-1  NIOThread@1
      INFO  HTTP.SERVICE - ExceptionHandler.handleException() :
      Exception java.io.IOException: Broken pipe occurred while writing to channel
      ClientOutputChannel(ClientChannel[Connected:
      Remote:IP:PORT Local:0.0.0.0:42828]@8380 useCount=1
      bytesRead=0 bytesWritten=76295 age=2012ms  lastIO=2ms  isOpen=false)

      atau

      Exception #2: onExceptionWrite exception: {}
      java.io.IOException: Broken pipe

      2021-01-31 15:29:37,438 org:anotherorg env:prod api:503-test
      rev:1 messageid:leonyoung-opdk-test-1-18604-13978-1
      NIOThread@0 ERROR HTTP.CLIENT - HTTPClient$Context$2.onException() :
      ClientChannel[Connected: Remote:IP:PORT
      Local:0.0.0.0:57880]@8569 useCount=1 bytesRead=0 bytesWritten=76295 age=3180ms  lastIO=2
      ms  isOpen=false.onExceptionWrite exception: {}
      java.io.IOException: Broken pipe
    • Kedua pengecualian ini menunjukkan bahwa saat Pemroses Pesan masih menulis payload permintaan ke server backend, koneksi ditutup sebelum waktunya oleh server backend. Oleh karena itu, Pemroses Pesan akan menampilkan pengecualian java.io.IOException: Broken pipe.
    • Remote:IP:PORT menunjukkan alamat IP dan nomor port server backend yang telah diselesaikan.
    • Atribut bytesWritten=76295 dalam pesan error di atas menunjukkan bahwa Message Processor telah mengirimkan payload 76295 byte ke server backend saat koneksi ditutup sebelum waktunya.
    • Atribut bytesRead=0 menunjukkan bahwa Message Processor belum menerima data (respons) apa pun dari server backend.
    • Untuk menyelidiki masalah ini lebih lanjut, kumpulkan tcpdump baik di server backend atau Message Processor dan analisis seperti yang dijelaskan di bawah.

Menggunakan tcpdump

  1. Ambil tcpdump di server backend atau Message Processor dengan perintah berikut:

    Perintah untuk mengumpulkan tcpdump di server backend:

    tcpdump -i any -s 0 host MP_IP_ADDRESS -w FILE_NAME
    

    Perintah untuk mengumpulkan tcpdump di Pemroses Pesan:

    tcpdump -i any -s 0 host BACKEND_HOSTNAME -w FILE_NAME
    
  2. Analisis tcpdump yang diambil:

    Contoh output tcpdump (dikumpulkan di Message Processor):

    alt_text

    Dalam tcpdump di atas, Anda dapat melihat hal berikut:

    1. Dalam paket 4, Message Processor mengirimkan permintaan POST ke server backend.
    2. Dalam paket 5, 8, 9, 10, 11, Message Processor terus mengirimkan payload permintaan ke server backend.
    3. Dalam paket 6 dan 7,server backend merespons dengan ACK untuk sebagian payload permintaan yang diterima dari Message Processor.
    4. Namun, dalam paket 12, alih-alih merespons dengan ACK untuk paket data aplikasi yang diterima dan selanjutnya merespons dengan payload respons, server backend malah merespons dengan FIN ACK yang memulai penutupan koneksi.
    5. Hal ini jelas menunjukkan bahwa server backend menutup koneksi sebelum waktunya saat Pemroses Pesan masih mengirimkan payload permintaan.
    6. Hal ini menyebabkan Pemroses Pesan mencatat error IOException: Broken Pipe dan menampilkan 503 ke klien

Resolusi

  1. Bekerjasamalah dengan tim aplikasi dan jaringan Anda untuk menganalisis dan memperbaiki masalah terputusnya koneksi secara prematur di sisi server backend.
  2. Pastikan aplikasi server backend tidak mengalami waktu tunggu habis atau mereset koneksi sebelum menerima seluruh payload permintaan.
  3. Jika Anda memiliki perangkat atau lapisan jaringan perantara antara Apigee dan server backend, pastikan perangkat atau lapisan tersebut tidak mengalami waktu tunggu habis sebelum seluruh payload permintaan diterima.

Jika masalah masih berlanjut, buka Informasi diagnostik yang harus dikumpulkan.

Harus mengumpulkan informasi diagnostik

Jika masalah berlanjut bahkan setelah mengikuti petunjuk di atas, 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 untuk mereproduksi error 503
  • File rekaman aktivitas yang berisi permintaan dengan error 503 Service Unavailable
  • Jika error 503 tidak terjadi saat ini, berikan jangka waktu dengan informasi zona waktu saat error 503 terjadi di masa lalu.

Jika Anda adalah pengguna Private Cloud, berikan informasi berikut:

  • Pesan error lengkap yang diamati untuk permintaan yang gagal
  • Nama Organisasi, Lingkungan, dan Proxy API yang Anda amati 503 errornya
  • Paket Proxy API
  • File rekaman aktivitas yang berisi permintaan dengan error 503 Service Unavailable
  • Log akses NGINX
    /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log
  • Log Message Processor
    /opt/apigee/var/log/edge-message-processor/logs/system.log
  • Jangka waktu dengan informasi zona waktu saat terjadi error 503
  • Tcpdumps yang dikumpulkan di Pemroses Pesan dan server backend saat terjadi error