API Gateway terintegrasi secara mulus dengan Simple Log Service untuk berbagai fitur. Sebagai contoh, Anda dapat menanyakan log, mengunduh log, dan melakukan analisis statistik multi-dimensi dari log secara real-time. Anda juga dapat mengirim log ke Object Storage Service (OSS) atau MaxCompute.
Simple Log Service memungkinkan Anda menghasilkan 500 MB data log secara gratis setiap bulan. Jika Anda menghasilkan lebih banyak data log daripada batas ini, kelebihannya akan dikenakan biaya. Untuk informasi lebih lanjut, lihat Pricing.
Ikhtisar
1. Pencarian log online
Anda dapat menggunakan kata kunci untuk mencari log. Baik pencocokan tepat maupun pencocokan kabur didukung. Pencarian log dapat digunakan untuk pemecahan masalah atau kueri statistik.
2. Log detail panggilan API
Tabel berikut mencantumkan bidang dalam log. Anda dapat mencari log berdasarkan bidang-bidang ini. Bidang requestQueryString, requestHeaders, requestBody, responseHeaders, dan responseBody hanya didukung oleh instance khusus yang terhubung melalui virtual private cloud (VPC) dan harus dikonfigurasi di halaman detail grup.
Bidang | Deskripsi |
apiGroupUid | ID grup tempat API tersebut termasuk. |
apiGroupName | Nama grup tempat API tersebut termasuk. |
apiUid | ID API. |
apiName | Nama API. |
apiStageUid | ID lingkungan tempat API dipanggil. |
apiStageName | Nama lingkungan. |
httpMethod | Metode HTTP yang digunakan oleh permintaan API. |
path | Path permintaan API. |
domain | Nama domain yang digunakan untuk pemanggilan API. |
statusCode | HttpStatusCode |
errorMessage | Pesan kesalahan yang dikembalikan. |
appId | ID aplikasi yang digunakan untuk memanggil API. |
appName | Nama aplikasi yang digunakan untuk memanggil API. |
clientIp | Alamat IP klien yang memulai pemanggilan API. |
exception | Pesan kesalahan spesifik yang dikembalikan oleh layanan backend API. |
exchangeTimestamp | Titik waktu I/O dalam tautan permintaan.
|
providerAliUid | ID akun yang menyediakan API. |
region | Wilayah tempat API berada, misalnya cn-hangzhou, yang menunjukkan wilayah China (Hangzhou). |
requestHandleTime | Titik waktu dalam UTC ketika permintaan API diterima oleh API Gateway. |
requestId | ID permintaan. ID ini bersifat unik secara global. |
requestSize | Ukuran permintaan. Satuan: byte. |
responseSize | Ukuran respons. Satuan: byte. |
serviceLatency | Total waktu yang digunakan untuk mengakses sumber daya backend. Total waktu mencakup waktu yang digunakan untuk meminta koneksi ke sumber daya, waktu yang digunakan untuk membangun koneksi, dan waktu yang digunakan untuk memanggil layanan backend. Satuan: milidetik. |
errorCode | Kode kesalahan, seperti X500ER. |
requestProtocol | Protokol yang digunakan oleh klien untuk mengirim permintaan. Nilai valid: HTTP, HTTPS, dan WS. |
instanceId | ID instance API Gateway tempat API tersebut termasuk. |
initialRequestId | Jika sebuah API memanggil API lain, misalnya, API-1 memanggil API-2, initialRequestId digunakan untuk mencatat ID permintaan API-1 dalam log API-2. |
clientNonce | Header X-Ca-Nonce dalam permintaan yang berasal dari klien. |
requestQueryString | queryString dalam permintaan yang berasal dari klien. Bidang ini hanya untuk instance khusus. |
requestHeaders | Konten header dalam permintaan yang berasal dari klien. Bidang ini hanya untuk instance khusus. |
requestBody | Body permintaan yang dikirim oleh klien. Body dapat berisi hingga 1.024 byte panjangnya. Bidang ini hanya untuk instance khusus. |
responseHeaders | Konten header dari respons API. Bidang ini hanya untuk instance khusus. |
responseBody | Konten respons. Respons dapat berisi hingga 1.024 byte panjangnya. Bidang ini hanya untuk instance khusus. |
consumerAppKey | AppKey yang digunakan dalam permintaan. |
totalLatency | Total latensi permintaan API. Satuan: milidetik. |
customTraceId | traceId dari log end-to-end. |
jwtClaims | Klaim JSON web token (JWT). Klaim dapat dikonfigurasi di tingkat grup. |
plugin | Plugin yang cocok dengan permintaan dan konteks terkait. |
Konfigurasikan layanan log untuk API Gateway
Konfigurasikan layanan log
Anda dapat mengonfigurasi layanan log untuk API Gateway dalam dua metode:
Sinkronkan log menggunakan layanan audit log di konsol Simple Log Service. Kemudian, log dari semua wilayah akan diagregasi dalam proyek yang dikonfigurasi tanpa memerlukan konfigurasi tambahan di API Gateway.
Hubungkan data API Gateway ke Simple Log Service dengan menyinkronkan konfigurasi untuk setiap wilayah.
Bagian ini menjelaskan kedua metode tersebut.
Hanya metode pertama yang didukung untuk menyinkronkan log di Alibaba Gov Cloud dan Alibaba Finance Cloud.
1. Konfigurasikan audit log
Buka halaman Log Audit Service di konsol Simple Log Service dan pilih wilayah proyek pusat. Semua log API Gateway akan dikirim ke wilayah ini.
Lakukan otorisasi menggunakan salah satu dari dua metode sesuai instruksi. Dalam contoh ini, otorisasi manual digunakan.
Setelah otorisasi selesai, lihat log panggilan API Gateway di apigateway_log di proyek pusat.
2. Konfigurasikan layanan log di konsol API Gateway
Pastikan bahwa Anda telah mengaktifkan Simple Log Service. Pilih wilayah yang sesuai di konsol Simple Log Service, lalu buat proyek dan penyimpanan log. Dalam contoh ini, wilayah China (Hangzhou) digunakan.
Pilih API Gateway sebagai sumber data.
Klik Berikutnya hingga konfigurasi selesai.
Lihat log panggilan API
Anda dapat masuk ke konsol Simple Log Service untuk melihat log dan mengambil log panggilan online berdasarkan sintaks kueri.
Konfigurasikan laporan kueri kustom
Anda dapat mengonfigurasi laporan kueri kustom berdasarkan kebutuhan bisnis Anda. Untuk informasi lebih lanjut, lihat Buat Dashboard.