Mengaktifkan log debug NGINX di Router

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

Di Apigee, Router dikonfigurasi untuk hanya mencatat pesan error dalam file log error dengan secara default. Namun, mungkin ada banyak situasi di mana Anda perlu mengumpulkan lebih banyak informasi untuk menentukan mengapa kesalahan tertentu terjadi. Salah satu cara untuk melakukannya adalah dengan mengkonfigurasi {i>Router<i} untuk beroperasi dalam mode debug sehingga Anda bisa mendapatkan log debug, yang dapat membantu Anda mendapatkan informasi lebih lanjut tentang {i>error<i} tersebut dan menyelesaikannya lebih cepat.

Dokumen ini menjelaskan cara mengaktifkan log debug di Router Apigee Edge untuk permintaan di {i>host<i} virtual tertentu. Logging debug dapat diaktifkan untuk mencatat informasi selengkapnya jika ada masalah seperti format permintaan yang salah, 400 Bad Request - SSL Certificate Error, pada Arah Utara (antara aplikasi Klien dan Router).

Sebelum memulai

  • Jika Anda tidak terbiasa dengan log error dan tingkat logging NGINX, lihat Dokumentasi log error NGINX.
  • Mengumpulkan nama organisasi, lingkungan, dan host virtual permintaan API yang Anda perlu mengumpulkan informasi debug.

Mengaktifkan log debug NGINX di Router

Bagian ini menjelaskan cara mengaktifkan log debug di Router Edge.

Mengidentifikasi file konfigurasi host virtual yang relevan

Langkah-langkah berikut menjelaskan cara menemukan file konfigurasi host virtual yang relevan di Router:

  1. Jika Anda mengetahui nama organisasi, nama lingkungan, dan host virtual untuk API tertentu yang ingin Anda debug, kemudian tentukan file conf host virtual seperti berikut:
    1. Buka direktori /opt/nginx/conf.d/.
    2. Telusuri file ORG_NAME_ENV_NAME_VIRTUALHOST.conf di direktori conf.d menggunakan perintah berikut: 
      ls -ltrh | grep "ORG_NAME_ENV_NAME_VIRTUALHOST_NAME"

  2. Jika tidak mengetahui nama organisasi, Anda dapat mengidentifikasi konfigurasi {i>host<i} virtual file Anda dengan menggunakan nama alias host yang digunakan dalam permintaan API sebagai berikut:

    Buka direktori /opt/nginx/conf.d/ dan telusuri hostalias yang digunakan untuk membuat permintaan menggunakan perintah berikut: 

    ls -ltrh | grep -r 'HOST_ALIAS_NAME'

    Contoh output:

    Sebut saja nama alias host adalah opdk.cert-test.com. Saat Anda menjalankan ls -ltrh, lalu Anda akan melihat output seperti yang ditunjukkan di bawah ini:

Mengaktifkan logging debug untuk host virtual tertentu di Router

Langkah-langkah berikut menjelaskan cara mengaktifkan log debug di Router Apigee untuk {i>host<i} virtual.

  1. Buka file berikut di mesin Router di editor: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf. Contoh: 
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
  2. Ubah baris berikut: 
    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;

    hingga 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
  3. Simpan perubahan.
  4. Jalankan perintah muat ulang NGINX. Contoh: 
    sudo /opt/nginx/scripts/apigee-nginx reload
  5. File berikut sekarang akan merekam log debug: 
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. Jika Anda ingin mengambil log debug di lebih dari satu Router, ulangi langkah-langkah ini pada setiap {i>Router<i}.

Memverifikasi informasi debug yang dicatat dalam file log error NGINX

  1. Setelah klien membuat Permintaan API pada alias host dan port yang terkait dengan host virtual konfigurasi, log debug akan direkam dalam file berikut:

    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log

  2. Pastikan Anda melihat informasi debug untuk permintaan API seperti yang ditunjukkan dalam contoh berikut:

    Contoh informasi debug:

    2021/01/27 02:48:40 [warn] 27624#27624: *3777 a client request body is buffered to a temporary file /opt/apigee/var/log/edge-router/nginx/client_temp/0000000001, client: XX.XX.XX.XX, server: XX.XX.XX.XX, request: "POST /post-no-target HTTP/1.1", host: "XX.XX.XX.XX:443"

    Informasi yang ditampilkan di atas akan diambil saat klien mengirim permintaan POST dengan payload yang besar. Log ini hanya akan ditampilkan jika logging debug diaktifkan.

  3. Jika Anda tidak melihat informasi debug tambahan, verifikasi bahwa Anda telah mengikuti semua langkah yang diuraikan dalam Mengaktifkan logging debug untuk host virtual tertentu di Router dengan benar. Jika Anda memiliki melewatkan langkah apa pun, ulangi semua langkah dengan benar.
  4. Jika Anda masih tidak bisa mendapatkan informasi debug, hubungi Dukungan Apigee Edge.

Menonaktifkan log debug untuk host virtual tertentu di Router

Bagian ini menjelaskan cara menonaktifkan log debug di Router untuk host virtual tertentu.

  1. Buka file berikut di mesin Router di editor: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf Contoh: 
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf

  2. Ubah baris berikut: 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;

    hingga 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
  3. Simpan perubahan.
  4. Jalankan perintah muat ulang NGINX. Contoh: 
    /opt/nginx/scripts/apigee-nginx reload
  5. File berikut sekarang hanya akan mengambil log error: 
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. Jika Anda ingin menghentikan log debug di lebih dari satu Router, ulangi langkah-langkah ini pada setiap {i>Router<i}.

Hanya memverifikasi informasi error yang dicatat dalam file log error NGINX

  1. Membuat beberapa permintaan API pada alias host dan port yang terkait dengan host virtual tertentu konfigurasi atau menunggu klien untuk membuat permintaan.
  2. Periksa file berikut: /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  3. Pastikan Anda hanya melihat informasi error dan informasi debug sudah tidak ada lagi dicatat untuk permintaan.
  4. Jika Anda masih melihat informasi debug tambahan yang sedang dicatat, verifikasi bahwa Anda telah mengikuti semua langkah yang diuraikan dalam Menonaktifkan log debug untuk host virtual tertentu di Router dengan benar. Jika Anda memiliki melewatkan langkah apa pun, ulangi semua langkah dengan benar.
  5. Jika Anda masih tidak bisa mendapatkan informasi debug, harap hubungi Dukungan Apigee Edge.