Memantau Manajemen API
BERLAKU UNTUK: Semua tingkatan API Management
Azure Monitor mengumpulkan dan menggabungkan metrik dan log dari sistem Anda untuk memantau ketersediaan, performa, dan ketahanan, dan memberi tahu Anda tentang masalah yang memengaruhi sistem Anda. Anda dapat menggunakan pustaka portal Azure, PowerShell, Azure CLI, REST API, atau klien untuk menyiapkan dan melihat data pemantauan.
Metrik dan log yang berbeda tersedia untuk berbagai jenis sumber daya. Artikel ini menjelaskan jenis data pemantauan yang dapat Anda kumpulkan untuk layanan ini dan cara menganalisis data tersebut.
Tabel ini menjelaskan bagaimana Anda dapat mengumpulkan data untuk memantau layanan Anda, dan apa yang dapat Anda lakukan dengan data setelah dikumpulkan:
| Data untuk dikumpulkan | Deskripsi | Cara mengumpulkan dan merutekan data | Tempat menampilkan data | Data yang didukung |
|---|---|---|---|---|
| Data metrik | Metrik adalah nilai numerik yang menjelaskan aspek sistem pada titik waktu tertentu. Metrik dapat diagregasi menggunakan algoritma, dibandingkan dengan metrik lain, dan dianalisis untuk tren dari waktu ke waktu. | - Dikumpulkan secara otomatis secara berkala.
- Anda dapat merutekan beberapa metrik platform ke ruang kerja Analitik Log untuk diuji dengan data lain. Periksa pengaturan ekspor DS untuk setiap metrik dan lihat apakah Anda dapat menggunakan pengaturan diagnostik untuk mengalihkan data metrik. |
Penjelajah metrik | Metrik Azure API Management yang didukung oleh Azure Monitor |
| Data log sumber daya | Log adalah peristiwa sistem yang direkam dengan tanda waktu. Log dapat berisi berbagai jenis data, dan teks terstruktur atau bentuk bebas. Anda dapat merutekan data log sumber daya ke ruang kerja Log Analytics untuk menjalankan kueri dan analisis. | Buat pengaturan diagnosa untuk mengumpulkan dan mengalirkan data log sumber daya. | Log Analitik | Data log sumber daya Azure API Management yang didukung oleh Azure Monitor |
| Data log aktivitas | Log aktivitas Azure Monitor memberikan wawasan tentang peristiwa pada tingkat langganan. Log aktivitas mencakup informasi seperti saat sumber daya dimodifikasi atau mesin virtual dimulai. | - Dikumpulkan secara otomatis.
- Buat pengaturan diagnostik untuk ruang kerja Analitik Log tanpa biaya. |
Log aktivitas |
Untuk daftar semua data yang didukung oleh Azure Monitor, lihat:
Azure API management memiliki fitur pemantauan bawaan berikut.
Azure API Management menyediakan analitik untuk API Anda sehingga Anda dapat menganalisis penggunaan dan performanya. Gunakan analitik untuk pemantauan tingkat tinggi dan pemecahan masalah API Anda. Untuk fitur pemantauan lainnya, termasuk metrik hampir real-time dan log sumber daya untuk diagnostik dan audit, lihat Tutorial: Memantau API yang diterbitkan.
Catatan
Saat ini, fitur ini tidak tersedia di ruang kerja.
- API Management menyediakan analitik menggunakan dasbor berbasis Azure Monitor. Dasbor mengumpulkan data di ruang kerja Azure Log Analytics.
- Di tingkat layanan API Management klasik, instans API Management Anda juga menyertakan analitik bawaan lama dalam portal Azure, dan data analitik dapat diakses menggunakan API Management REST API. Data serupa erat ditampilkan di dasbor berbasis Azure Monitor dan analitik bawaan.
Penting
Dasbor berbasis Azure Monitor adalah cara yang disarankan untuk mengakses data analitik. Analitik bawaan (klasik) tidak tersedia di tingkat v2.
Dengan analitik API, analisis penggunaan dan performa API dalam instans API Management Anda di beberapa dimensi, termasuk:
- Waktu
- Geografi
- API
- Pengoperasian API
- Produk
- Langganan
- Pengguna
- Permintaan
Analitik API menyediakan data atas permintaan, termasuk permintaan yang gagal dan tidak sah. Nilai geografi didasarkan pada pemetaan alamat IP. Mungkin ada keterlambatan dalam ketersediaan data analitik.
Untuk menggunakan dasbor berbasis Azure Monitor, Anda memerlukan workspace Log Analytics sebagai sumber data untuk log dari gateway API Management.
Jika Anda perlu mengonfigurasinya, berikut ini adalah langkah-langkah singkat untuk mengirim log gateway ke ruang kerja Analitik Log. Untuk informasi selengkapnya, lihat Tutorial: Memantau API yang diterbitkan. Prosedur ini adalah penyiapan satu kali.
- Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
- Di menu sebelah kiri, di bawah Pemantauan, pilih > diagnostik+ Tambahkan pengaturan diagnostik.
- Masukkan nama deskriptif untuk pengaturan diagnostik.
- Di Log, pilih Log yang terkait dengan ApiManagement Gateway.
- Di Detail Tujuan, pilih Kirim ke Log Analytics dan pilih ruang kerja Log Analytics dalam langganan yang sama atau berbeda. Jika Anda perlu membuat ruang kerja, lihat Membuat ruang kerja Log Analytics.
- Pastikan Spesifik Sumber Daya dipilih sebagai tabel tujuan.
- Pilih Simpan.
Penting
Ruang kerja Analitik Log baru dapat memakan waktu hingga 2 jam untuk mulai menerima data. Ruang kerja yang ada harus mulai menerima data dalam waktu sekitar 15 menit.
Setelah ruang kerja Analitik Log dikonfigurasi, akses dasbor berbasis Azure Monitor untuk menganalisis penggunaan dan performa API Anda.
- Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
- Di menu sebelah kiri, di bawah Pemantauan, pilih Analitik. Dasbor analitik terbuka.
- Pilih rentang waktu untuk data.
- Pilih kategori laporan untuk data analitik, seperti Garis Waktu, Geografi, dan sebagainya.
Dalam tingkat layanan API Management tertentu, analitik bawaan (juga disebut analitik warisan atau analitik klasik) juga tersedia di portal Azure, dan data analitik dapat diakses menggunakan API Management REST API.
Untuk mengakses analitik bawaan (klasik) di portal Azure:
- Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
- Di menu sebelah kiri, di bawah Pemantauan, pilih Analitik (klasik).
- Pilih rentang waktu untuk data, atau masukkan rentang waktu kustom.
- Pilih kategori laporan untuk data analitik, seperti Garis Waktu, Geografi, dan sebagainya.
- Secara opsional, filter laporan menurut satu atau beberapa kategori lainnya.
Gunakan pengoperasian Laporan di API Management REST API untuk mengambil dan menyaring data analitik untuk instans API Management Anda.
Pengoperasian yang tersedia mengembalikan catatan laporan berdasarkan API, geografi, pengoperasian API, produk, permintaan, langganan, waktu, atau pengguna.
Bagian ini memperlihatkan kepada Anda cara mengaktifkan log Azure Monitor untuk mengaudit dan memecahkan masalah penggunaan portal pengembang API Management. Saat diaktifkan melalui pengaturan diagnostik, log mengumpulkan informasi tentang permintaan yang diterima dan diproses oleh portal pengembang.
Log penggunaan portal pengembang menyertakan data tentang aktivitas di portal pengembang, termasuk:
- Tindakan autentikasi pengguna, seperti masuk dan keluar
- Tampilan detail API, detail operasi API, dan produk
- Pengujian API di konsol pengujian interaktif
Untuk mengonfigurasi pengaturan diagnostik untuk log penggunaan portal pengembang:
Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
Di menu sebelah kiri, di bawah Pemantauan, pilih Pengaturan> diagnostik+ Tambahkan pengaturan diagnostik.
Pada halaman Pengaturan diagnostik, masukkan atau pilih detail untuk pengaturan:
- Nama pengaturan diagnostik: Masukkan nama deskriptif.
- Grup kategori: Secara opsional buat pilihan untuk skenario Anda.
- Di bawah Kategori: Pilih Log yang terkait dengan penggunaan Portal Pengembang. Secara opsional pilih kategori lain sesuai kebutuhan.
- Di bawah Detail tujuan, pilih satu atau beberapa opsi dan tentukan detail untuk tujuan. Misalnya, mengarsipkan log ke akun penyimpanan atau mengalirkannya ke hub peristiwa. Untuk informasi selengkapnya, lihat Pengaturan diagnostik di Azure Monitor.
- Pilih Simpan.
Bergantung pada tujuan log yang Anda pilih, diperlukan waktu beberapa menit agar data muncul.
Jika Anda mengirim log ke akun penyimpanan, Anda dapat mengakses data di portal Azure dan mengunduhnya untuk analisis.
- Di portal Azure, navigasikan ke tujuan akun penyimpanan.
- Di menu sebelah kiri, pilih Penyimpanan Browser.
- Di bawah kontainer Blob, pilih insights-logs-developerportalauditlogs.
- Navigasikan ke kontainer untuk log di instans API Management Anda. Log dibagi dalam periode satu jam.
- Untuk mengambil data untuk analisis lebih lanjut, pilih Unduh.
Alat Azure Monitor ini tersedia di portal Azure untuk membantu Anda menganalisis data pemantauan:
Beberapa layanan Azure memiliki dasbor pemantauan bawaan di portal Azure. Dasbor ini disebut wawasan, dan Anda dapat menemukannya di bagian Wawasan Azure Monitor di portal Azure.
Penjelajah metrik memungkinkan Anda melihat dan menganalisis metrik untuk sumber daya Azure. Untuk informasi selengkapnya, lihat Menganalisis metrik dengan penjelajah metrik Azure Monitor.
Log Analytics memungkinkan Anda untuk mengkueri dan menganalisis data log menggunakan bahasa kueri Kusto (KQL). Untuk informasi selengkapnya, lihat Mulai menggunakan kueri Log di Azure Monitor.
portal Azure memiliki antarmuka pengguna untuk melihat log aktivitas dan melakukan pencarian dasar di dalamnya. Untuk melakukan analisis yang lebih mendalam, rutekan data ke log Azure Monitor dan jalankan kueri yang lebih kompleks di Analitik Log.
Application Insights memantau ketersediaan, performa, dan penggunaan aplikasi web Anda, sehingga Anda dapat mengidentifikasi dan mendiagnosis kesalahan tanpa menunggu pengguna melaporkannya.
Application Insights mencakup titik koneksi ke berbagai alat pengembangan dan terintegrasi dengan Visual Studio untuk mendukung proses DevOps Anda. Untuk informasi selengkapnya, lihat Pemantauan aplikasi untuk App Service.
Alat yang memungkinkan visualisasi yang lebih kompleks meliputi:
- Dasbor yang memungkinkan Anda menggabungkan berbagai jenis data ke dalam satu panel di portal Azure.
- Buku kerja, laporan yang dapat disesuaikan yang bisa Anda buat di portal Azure. Buku kerja dapat menyertakan kueri teks, metrik, dan log.
- Grafana, alat platform terbuka yang unggul di dasbor operasional. Anda dapat menggunakan Grafana untuk membuat dasbor yang menyertakan data dari beberapa sumber selain Azure Monitor.
- Power BI, layanan analitik bisnis yang menyediakan visualisasi interaktif di berbagai sumber data. Anda dapat mengonfigurasi Power BI untuk mengimpor data log secara otomatis dari Azure Monitor untuk memanfaatkan visualisasi ini.
Anda dapat menggunakan Azure Managed Grafana untuk memvisualisasikan data pemantauan API Management yang dikumpulkan ke dalam ruang kerja Analitik Log. Gunakan dasbor API Management bawaan untuk visualisasi log dan metrik real time yang dikumpulkan dari instans API Management Anda.
- Pelajari selengkapnya tentang Azure Managed Grafana
- Pelajari selengkapnya tentang pengamatan di Azure API Management
Pada instans API Management Anda:
Untuk memvisualisasikan log dan metrik sumber daya untuk API Management, konfigurasikan pengaturan diagnostik untuk mengumpulkan log sumber daya dan mengirimkannya ke ruang kerja Analitik Log.
Untuk memvisualisasikan data terperinci tentang permintaan ke gateway API Management, integrasikan instans API Management Anda dengan Application Insights.
Catatan
Untuk memvisualisasikan data dalam satu dasbor, konfigurasikan ruang kerja Analitik Log untuk pengaturan diagnostik dan instans Application Insights dalam grup sumber daya yang sama dengan instans API Management Anda.
Di ruang kerja Grafana Terkelola Anda:
- Untuk membuat instans dan ruang kerja Managed Grafana, lihat panduan memulai cepat untuk portal atau Azure CLI.
- Instans Managed Grafana harus berada dalam langganan yang sama dengan instans API Management.
- Saat dibuat, ruang kerja Grafana secara otomatis diberi identitas terkelola Microsoft Entra, yang diberi peran Pembaca Monitor pada langganan tersebut. Pendekatan ini memberi Anda akses langsung ke Azure Monitor dari ruang kerja Grafana baru tanpa perlu mengatur izin secara manual. Pelajari selengkapnya tentang mengonfigurasi sumber data untuk Grafana Terkelola.
Pertama-tama impor dasbor API Management ke ruang kerja Management Grafana Anda.
Untuk mengimpor dasbor:
- Buka ruang kerja Azure Managed Grafana Anda. Di portal, di halaman Gambaran Umum instans Grafana Terkelola Anda, pilih tautan Endpoint.
- Di ruang kerja Managed Grafana, buka Dasbor>Telusuri>Impor.
- Pada halaman Impor , di bawah Impor melalui grafana.com, masukkan 16604 dan pilih Muat.
- Pilih sumber data Azure Monitor, tinjau atau perbarui opsi lain, dan pilih Impor.
Untuk menggunakan dasbor API Management:
- Di ruang kerja Grafana Terkelola, buka Dasbor>Telusuri dan pilih dasbor API Management Anda.
- Di menu dropdown di bagian atas, buat pilihan untuk instans API Management Anda. Jika sudah dikonfigurasi, pilih instans dari Application Insights dan ruang kerja untuk Analitik Log.
Tinjau visualisasi default di dasbor, yang tampak mirip dengan cuplikan layar berikut:
Anda dapat mengekspor data dari Azure Monitor ke alat lain menggunakan:
Metrik: Gunakan REST API untuk metrik untuk mengekstrak data metrik dari database metrik Azure Monitor. Untuk informasi selengkapnya, lihat Referensi REST API Azure Monitor.
Log: Gunakan REST API atau pustaka klien terkait.
Ekspor data Log Analytics ruang kerja.
Untuk mulai menggunakan REST API Azure Monitor, lihat Panduan REST API pemantauan Azure.
Anda dapat menganalisis data Log Azure Monitor menggunakan bahasa kueri Kusto (KQL). Untuk informasi selengkapnya, lihat Mencatat kueri di Azure Monitor.
Pemberitahuan Azure Monitor memungkinkan Anda mengidentifikasi dan mengatasi masalah dalam sistem Anda, dan secara proaktif memberi tahu Anda saat kondisi tertentu ditemukan di data pemantauan Anda sebelum pelanggan Anda memperhatikannya. Anda dapat memperingatkan metrik atau sumber data log apa pun di platform data Azure Monitor. Ada berbagai jenis pemberitahuan Azure Monitor tergantung pada layanan yang Anda pantau dan data pemantauan yang Anda kumpulkan. Lihat Memilih jenis aturan pemberitahuan yang tepat.
Untuk melihat cara menyiapkan aturan pemberitahuan di Azure API Management, lihat Menyiapkan aturan pemberitahuan.
Untuk contoh peringatan umum sumber daya Azure, lihat Contoh kueri peringatan log.
Untuk beberapa layanan, Anda dapat memantau dalam skala besar dengan menerapkan aturan pemberitahuan metrik yang sama ke beberapa sumber daya dengan jenis yang sama yang ada di wilayah Azure yang sama. Azure Monitor Baseline Alerts (AMBA) menyediakan metode semi-otomatis untuk menerapkan pemberitahuan metrik platform, dasbor, dan panduan penting dalam skala besar.
Untuk beberapa layanan, jika kondisi penting atau perubahan segera terjadi selama operasi sumber daya, pemberitahuan ditampilkan di halaman Gambaran Umum layanan di portal. Anda dapat menemukan informasi selengkapnya dan perbaikan yang direkomendasikan untuk pemberitahuan di rekomendasi Advisor di bawah Pemantauan di menu sebelah kiri. Selama operasi normal, tidak ada rekomendasi advisor yang ditampilkan.
Untuk informasi selengkapnya tentang Azure Advisor, lihat Gambaran umum Azure Advisor.