Observabilitas di Azure API Management

BERLAKU UNTUK: Semua tingkat layanan API Management

Observabilitas adalah kemampuan untuk memahami status internal sistem dari data yang dihasilkannya dan kemampuan untuk mengeksplorasi data tersebut guna menjawab pertanyaan tentang apa yang terjadi dan mengapa dapat terjadi.

Azure API Management membantu organisasi memusatkan pengelolaan semua API. Karena berfungsi sebagai satu titik masuk dari semua lalu lintas API, ini adalah tempat yang ideal untuk mengamati API.

Gambaran Umum

Azure API Management memungkinkan Anda memilih untuk menggunakan gateway terkelola atau gateway yang dihost sendiri, baik yang disebarkan sendiri atau menggunakan ekstensi Azure Arc.

Tabel berikut ini meringkas semua kemampuan pengamatan yang didukung oleh API Management untuk mengoperasikan API dan model penyebaran apa yang mereka dukung. Penerbit API dan lainnya dengan izin untuk mengoperasikan atau mengelola instans API Management dapat menggunakan kemampuan ini.

Catatan

Untuk konsumen API yang menggunakan portal pengembang, laporan API bawaan tersedia. Laporan ini hanya memberikan informasi tentang penggunaan setiap API mereka selama 90 hari sebelumnya. Saat ini, laporan API bawaan tidak tersedia di portal pengembang untuk tingkat layanan v2.

Alat Berguna untuk Keterlambatan data4 Retensi Pengambilan sampel Jenis data Model Penyebaran yang Didukung
Pelacakan permintaan (Pemeriksa API) Pengujian dan debugging Instan 100 pelacakan terakhir Diaktifkan sesuai permintaan Meminta jejak Dikelola, Dihost sendiri, Azure Arc, Ruang Kerja
Analisis Terintegrasi Pelaporan dan Pemantauan Menit Seumur hidup 100% Laporan dan log Terkelola
Metrik di Azure Monitor Pelaporan dan Pemantauan Menit 90 hari (tingkatkan untuk memperpanjang) 100% Metrik Terkelola, Dihost sendiri2, Azure Arc
Log Azure Monitor Pelaporan, pemantauan, dan penelusuran kesalahan Menit 31 hari/5GB (mutakhirkan untuk memperpanjang) 100% (dapat disesuaikan) Log Terkelola1, Dihost sendiri3, Azure Arc3
Azure Application Insights Pelaporan, pemantauan, dan penelusuran kesalahan Detik 90 hari/5GB (mutakhirkan untuk memperpanjang) Kustom Log, metrik Terkelola1, Dihostsendiri 1, Azure Arc1, RuangKerja 1
Pengelogan melalui Azure Event Hubs Skenario khusus Detik Dikelola oleh pengguna Kustom Kustom Terkelola1, Dihost sendiri1, Azure Arc1
OpenTelemetry Pemantauan Menit Dikelola oleh pengguna 100% Metrik Dihost sendiri2

1 Opsional, tergantung pada konfigurasi fitur di Azure API Management.
2 Opsional, tergantung pada konfigurasi gateway.
3Gateway yang dihost sendiri saat ini tidak mengirim log diagnostik ke Azure Monitor. Namun, log dapat dikonfigurasi dan disimpan secara persisten secara lokal pada tempat gateway yang dihosting sendiri diterapkan. Untuk informasi selengkapnya, lihat mengonfigurasi metrik dan log lokal untuk gateway yang dihost sendiri.
4 Kecuali untuk pelacakan permintaan, semua pengelogan di API Management terjadi secara asinkron.

Praktik terbaik

Praktik berikut dapat meningkatkan pengamatan API Anda:

  • Pemantauan granular: Aktifkan metrik per-metode untuk wawasan mendetail tentang waktu respons dan tingkat kesalahan.
  • Pemantauan latensi ekor: Mengonfigurasi pemberitahuan per metode untuk latensi ekor (misalnya, persentil ke-90, ke-95, atau ke-99), karena latensi rata-rata dapat menyesatkan. Untuk menerapkan fitur ini, gunakan Kusto Query Language (KQL) untuk meneruskan log ke ruang kerja Log Analytics.
  • Pemberitahuan proaktif: Menetapkan pemberitahuan per metode untuk tingkat kesalahan dan tingkat keberhasilan rendah , gunakan tingkat alih-alih hitungan untuk memastikan akurasi.
  • Pelacakan terdistribusi: Mengaktifkan pelacakan untuk mengidentifikasi hambatan performa dan memecahkan masalah.
  • Penandaan sumber daya: Terapkan tag ke API untuk pelacakan dan alokasi biaya yang akurat.

Konten terkait

  • Last updated on