Tutorial: Memantau API yang diterbitkan

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Dengan Azure Monitor, Anda dapat memvisualisasikan, mengkueri, merutekan, mengarsipkan, dan melakukan tindakan pada metrik atau log yang berasal dari layanan Azure API Management Anda.

Dalam tutorial ini, Anda akan mempelajari cara:

  • Melihat metrik API Anda
  • Menyiapkan aturan pemberitahuan
  • Melihat log aktivitas
  • Mengaktifkan dan melihat log sumber daya

Catatan

API Management mendukung berbagai alat tambahan untuk mengamati API, termasuk analitik dan integrasi bawaan dengan Application Insights. Pelajari lebih lanjut

Prasyarat

Melihat metrik API Anda

API Management memancarkan metrik setiap menit, memberi Anda visibilitas hampir real-time ke dalam kondisi dan kesehatan API Anda. Berikut ini adalah dua metrik yang paling sering digunakan. Untuk daftar semua metrik yang tersedia, lihat metrik yang didukung.

  • Kapasitas - membantu Anda membuat keputusan tentang meningkatkan/menurunkan layanan API Management Anda. Metrik dipancarkan per menit dan mencerminkan perkiraan kapasitas gateway pada saat pelaporan. Metrik berkisar antara 0-100 yang dihitung berdasarkan sumber daya gateway seperti pemanfaatan CPU dan memori.
  • Permintaan - membantu Anda menganalisis lalu lintas API melalui layanan API Management Anda. Metrik dipancarkan per menit dan melaporkan jumlah permintaan gerbang dengan dimensi. Filter permintaan menurut kode respons, lokasi, nama host, dan kesalahan.

Penting

Metrik berikut tidak digunakan lagi per Mei 2019 dan akan dihentikan pada Agustus 2023: Total Permintaan Gateway, Permintaan Gateway berhasil, Permintaan Gateway Tidak Sah, Permintaan Gateway Gagal, Permintaan Gateway Lainnya. Silakan migrasi ke metrik Permintaan yang menyediakan fungsionalitas yang setara.

Cuplikan layar Metrik dalam Gambaran Umum API Management

Untuk mengakses metrik:

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda. Pada halaman Gambaran Umum , pada tab Monitor , tinjau metrik utama untuk API Anda.

  2. Untuk menyelidiki metrik secara rinci, pilih Metrik dari menu sebelah kiri.

    Cuplikan layar item Metrik di menu Pemantauan di portal.

  3. Dari menu drop-down, pilih metrik yang Anda minati. Misalnya, metrik Permintaan.

  4. Bagan menunjukkan jumlah total panggilan API. Sesuaikan rentang waktu untuk fokus pada periode yang diminati.

  5. Anda dapat memfilter bagan menggunakan dimensi metrik Permintaan. Misalnya, pilih Tambahkan filter, pilih Kategori Kode Respons Backend, masukkan 500 sebagai nilai. Bagan menunjukkan jumlah permintaan yang gagal di backend API.

Menyiapkan aturan pemberitahuan

Anda dapat menerima peringatan berdasarkan metrik dan log aktivitas. Di Azure Monitor, konfigurasikan aturan pemberitahuan untuk melakukan tindakan saat memicu. Tindakan umum meliputi:

  • Mengirim pemberitahuan email
  • Memanggil webhook
  • Meminta Aplikasi Logika Azure

Untuk mengonfigurasi contoh aturan pemberitahuan berdasarkan metrik permintaan:

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

  2. Pilih Pemberitahuan dari menu sebelah kiri.

    Cuplikan layar opsi Pemberitahuan di menu Pemantauan di portal.

  3. Pilih + Buat>aturan Pemberitahuan.

  4. Di jendela Pilih sinyal pada tab Kondisi :

    1. Dalam Tipe sinyal, pilih Metrik.
    2. Dalam Nama sinyal, pilih Permintaan.
    3. Dalam Logika pemberitahuan, tentukan nilai Ambang, yang merupakan jumlah kemunculan setelah pemberitahuan harus dipicu.
    4. Di Pisahkan menurut dimensi, dalam Nama dimensi, pilih Kategori Kode Respons Gateway.
    5. Dalam Nilai dimensi, pilih 4xx, untuk kesalahan klien seperti permintaan yang tidak sah atau tidak valid. Jika nilai dimensi tidak muncul, pilih Tambahkan nilai kustom dan masukkan 4xx.
    6. Di Kapan harus mengevaluasi, terima pengaturan default, atau pilih pengaturan lain untuk mengonfigurasi seberapa sering aturan berjalan. Pilih Selanjutnya.

    Cuplikan layar mengonfigurasi logika pemberitahuan di portal.

  5. Pada tab Tindakan , pilih atau buat satu atau beberapa grup tindakan untuk memberi tahu pengguna tentang pemberitahuan dan mengambil tindakan. Misalnya, buat grup tindakan baru untuk mengirim email pemberitahuan ke admin@contoso.com. Untuk langkah-langkah mendetail, lihat Membuat dan mengelola grup tindakan di portal Azure.

    Cuplikan layar mengonfigurasi pemberitahuan untuk grup tindakan baru di portal.

  6. Pada tab Detail dari Buat aturan pemberitahuan, masukkan nama dan deskripsi aturan pemberitahuan dan pilih tingkat keparahan.

  7. Konfigurasikan pengaturan yang tersisa secara opsional. Lalu, pada tab Tinjau + buat , pilih Buat.

  8. Sekarang, uji aturan pemberitahuan dengan memanggil API Konferensi tanpa menggunakan kunci API. Contohnya:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Peringatan memicu berdasarkan periode evaluasi, dan akan mengirim email ke admin@contoso.com.

    Pemberitahuan juga muncul di halaman Pemberitahuan untuk instans API Management.

    Cuplikan layar pemberitahuan di portal.

Log aktivitas

Log aktivitas memberikan wawasan tentang operasi pada layanan API Management Anda. Dengan menggunakan log aktivitas, Anda dapat menentukan "apa, siapa, dan kapan" untuk setiap operasi tulis (TEMPATKAN, KIRIMKAN, HAPUS) yang diambil di namespace layanan API Management Anda.

Catatan

Log aktivitas tidak menyertakan operasi baca (GET) atau operasi yang dilakukan di portal Microsoft Azure atau menggunakan API Management asli.

Anda dapat mengakses log aktivitas di layanan API Management, atau mengakses log semua sumber daya Azure Anda di Azure Monitor.

Cuplikan layar log aktivitas di portal.

Untuk melihat log aktivitas:

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

  2. Pilih Log aktivitas.

    Cuplikan layar item log Aktivitas di menu Pemantauan di portal.

  3. Pilih lingkup pemfilteran yang diinginkan kemudian Terapkan.

Log sumber daya

Log sumber daya (log Azure Monitor) menyediakan informasi kaya tentang operasi dan kesalahan API Management yang penting untuk tujuan audit dan pemecahan masalah. Saat diaktifkan melalui pengaturan diagnostik, log mengumpulkan informasi tentang permintaan API yang diterima dan diproses oleh gateway API Management.

Catatan

Tingkat Konsumsi tidak mendukung pengumpulan log sumber daya.

Untuk mengonfigurasi log sumber daya:

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

  2. Pilih Pengaturan diagnostik.

    Cuplikan layar item Pengaturan diagnostik di menu Pemantauan di portal.

  3. Pilih + Tambah pengaturan diagnostik.

  4. Pilih log atau metrik yang ingin Anda kumpulkan.

    Anda memiliki beberapa opsi tentang tempat mengirim log dan metrik. Misalnya, mengarsipkan log sumber daya bersama dengan metrik ke akun penyimpanan, mengalirkannya ke hub peristiwa, atau mengirimkannya ke ruang kerja Analitik Log.

    Tip

    Jika Anda memilih ruang kerja Analitik Log, Anda dapat memilih untuk menyimpan data di tabel ApiManagementGatewayLogs khusus sumber daya atau menyimpan di tabel AzureDiagnostics umum. Sebaiknya gunakan tabel khusus sumber daya untuk tujuan log yang mendukungnya. Pelajari lebih lanjut

  5. Setelah mengonfigurasi detail untuk tujuan log atau tujuan, pilih Simpan.

Catatan

Menambahkan objek pengaturan diagnostik dapat mengakibatkan kegagalan jika properti MinApiVersion dari layanan API Management Anda diatur ke versi API apa pun yang lebih tinggi dari pratinjau 2022-09-01.

Untuk informasi selengkapnya, lihat Membuat pengaturan diagnostik untuk mengirim log dan metrik platform ke tujuan yang berbeda.

Melihat data diagnostik di Azure Monitor

Jika Anda mengaktifkan pengumpulan log atau metrik di ruang kerja Analitik Log, diperlukan waktu beberapa menit agar data muncul di Azure Monitor.

Untuk menampilkan data :

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

  2. Pilih Log dari menu sebelah kiri.

    Cuplikan layar item Log di menu Pemantauan di portal.

  3. Jalankan kueri untuk melihat data. Beberapa contoh kueri disediakan, atau jalankan milik Anda sendiri. Misalnya, kueri berikut mengambil data 24 jam terbaru dari tabel ApiManagementGatewayLogs:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Cuplikan layar kueri tabel ApiManagementGatewayLogs di portal.

Untuk informasi selengkapnya tentang menggunakan log sumber daya untuk Manajemen API, lihat:

Mengubah pengaturan pengelogan API

Secara default, saat Anda membuat pengaturan diagnostik untuk mengaktifkan pengumpulan log sumber daya, pengelogan diaktifkan untuk semua API, dengan pengaturan default. Anda dapat menyesuaikan pengaturan pengelogan untuk semua API, atau menggantinya untuk API individual. Misalnya, sesuaikan laju pengambilan sampel atau verbositas data, atau nonaktifkan pengelogan untuk beberapa API.

Untuk detail tentang pengaturan pengelogan, lihat Referensi pengaturan pembuatan log diagnostik.

Untuk mengonfigurasi pengaturan pengelogan untuk semua API:

  1. Di menu sebelah kiri instans API Management Anda, pilih API>Semua API.
  2. Pilih tab Pengaturan dari bilah atas.
  3. Gulir ke bawah ke bagian Log Diagnostik, dan pilih tab Azure Monitor .
  4. Tinjau pengaturan dan buat perubahan jika diperlukan. Pilih Simpan.

Untuk mengonfigurasi pengaturan pengelogan untuk API tertentu:

  1. Di menu sebelah kiri instans API Management Anda, pilih API lalu nama API.
  2. Pilih tab Pengaturan dari bilah atas.
  3. Gulir ke bawah ke bagian Log Diagnostik, dan pilih tab Azure Monitor .
  4. Tinjau pengaturan dan buat perubahan jika diperlukan. Pilih Simpan.

Langkah berikutnya

Dalam tutorial ini, Anda mempelajari cara:

  • Melihat metrik API Anda
  • Menyiapkan aturan pemberitahuan
  • Melihat log aktivitas
  • Mengaktifkan dan melihat log sumber daya

Melanjutkan ke tutorial berikutnya:

Melacak panggilan