Referensi pengaturan log diagnostik: API Management

BERLAKU UNTUK: Semua tingkatAN API Management

Referensi ini menjelaskan pengaturan untuk pembuatan log diagnostik API dari instans API Management. Untuk mengaktifkan pengelogan permintaan API, lihat panduan berikut:

• Mengumpulkan log sumber daya
• Mengintegrasikan Azure API Management dengan Azure Application Insights

Catatan

Pengaturan tertentu, jika dicatat, hanya berlaku untuk pengelogan ke Application Insights.

Pengaturan	Tipe	Deskripsi
Aktifkan	Boolean	Menentukan apakah pengelogan API ini diaktifkan. Pengelogan dapat diaktifkan untuk semua API atau untuk API individual. Pengaturan untuk pengaturan penggantian API individual untuk semua API, jika diaktifkan.
Tujuan	Pencatat Azure Application Insights	Menentukan pencatat yang akan digunakan untuk pengelogan Application Insights.
Pengambilan sampel (%)	desimal	Nilai dari 0 hingga 100 (persen). Menentukan persentase permintaan yang dicatat. Pengambilan sampel 0 % berarti tidak ada permintaan yang dicatat, sedangkan pengambilan sampel 100 % berarti semua permintaan dicatat. Default: 100 Untuk dampak performa pengelogan Application Insights, lihat Implikasi performa dan pengambilan sampel log.
Selalu catat kesalahan	Boolean	Jika pengaturan ini diaktifkan, semua kegagalan dicatat, terlepas dari pengaturan Pengambilan Sampel .
Catat alamat IP klien	Boolean	Jika pengaturan ini diaktifkan, alamat IP klien untuk permintaan API dicatat.
Verbositas		Menentukan verbositas log dan apakah jejak kustom yang dikonfigurasi dalam kebijakan pelacakan dicatat. * Kesalahan - permintaan yang gagal, dan jejak tingkat keparahan kustom error * Informasi - permintaan yang gagal dan berhasil, dan jejak kustom tingkat keparahan error dan information * Verbose - permintaan yang gagal dan berhasil, dan jejak keparahan errorkustom , , informationdan verbose Default: Informasi
Protokol korelasi		Menentukan protokol yang digunakan untuk menghubungkan telemetri yang dikirim oleh beberapa komponen ke Application Insights. Default: Warisan Untuk informasi, lihat Korelasi telemetri di Application Insights.
Header yang akan dicatat	list	Menentukan header yang dicatat untuk permintaan dan respons. Default: tidak ada header yang dicatat.
Jumlah byte payload (isi) untuk dicatat	Integer	Menentukan jumlah byte awal permintaan frontend atau backend atau isi respons yang dicatat. Maksimum: 8.192. Default: 0
Permintaan Frontend		Menentukan apakah dan bagaimana permintaan frontend (permintaan yang masuk ke gateway API Management) dicatat. Jika pengaturan ini diaktifkan, tentukan Header yang akan dicatat, Jumlah byte payload untuk dicatat, atau keduanya.
Respons Frontend		Menentukan apakah dan bagaimana respons frontend (respons keluar dari gateway API Management) dicatat. Jika pengaturan ini diaktifkan, tentukan Header yang akan dicatat, Jumlah byte payload untuk dicatat, atau keduanya.
Permintaan Backend		Menentukan apakah dan bagaimana permintaan backend (permintaan keluar dari gateway API Management) dicatat. Jika pengaturan ini diaktifkan, tentukan Header yang akan dicatat, Jumlah byte payload untuk dicatat, atau keduanya.
Respons Backend		Menentukan apakah dan bagaimana respons backend (respons yang masuk ke gateway API Management) dicatat. Jika pengaturan ini diaktifkan, tentukan Header yang akan dicatat, Jumlah byte payload untuk dicatat, atau keduanya.

Penting

Jika diaktifkan, payload permintaan atau respons yang dicatat dapat mencapai 8.192 byte. API Management juga memberlakukan batas 32 KB untuk entri log diagnostik yang dikirim ke Azure Monitor, yang mencakup payload dan atribut lain seperti kode status, header, dan tanda waktu. Jika ukuran gabungan atribut melebihi 32 KB, API Management memangkas entri dengan menghapus semua isi dan melacak konten.

Langkah berikutnya

• Untuk informasi selengkapnya, lihat referensi untuk entitas Diagnostik di API Management REST API.
• Gunakan kebijakan pelacakan untuk menambahkan jejak kustom ke telemetri Application Insights, log sumber daya, atau pelacakan permintaan.