Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Bagian ini membandingkan Pemantauan API dengan Edge Analytics. Meskipun API Monitoring dan Edge Analytics memungkinkan Anda mengumpulkan dan melihat data API, keduanya memiliki tujuan yang berbeda:
- Tujuan Pemantauan API adalah untuk memastikan bahwa API Anda berjalan dan beroperasi seperti yang diharapkan. Untuk tujuan ini, Anda ingin melihat data terbaru yang tersedia. Pemantauan API menyediakan data yang sangat mendekati real-time, dan memungkinkan Anda membuat pemberitahuan yang memberi tahu Anda jika terjadi masalah.
- Tujuan Analisis Edge adalah untuk memahami perilaku jangka panjang API Anda, sehingga Anda dapat memastikan API tersebut mendukung persyaratan bisnis Anda, atau melakukan perubahan jika diperlukan. Untuk tujuan ini, melihat data real-time kurang penting. Akibatnya, data Analytics sedikit tertunda, meskipun biasanya paling lama 10 menit.
Perhatikan bahwa data Pemantauan API, yang sebagian besar terkait dengan kode error dan latensi, adalah subkumpulan kecil data Analytics.
Perbedaan antara data Pemantauan API dan data Analytics
Bagian ini menjelaskan beberapa perbedaan kecil antara data yang dikumpulkan oleh Edge Analytics dan Pemantauan API. Karena Pemantauan dan Analisis API menggunakan pipeline data yang berbeda, Anda mungkin melihat sedikit perbedaan antara laporan kustom yang dihasilkan oleh Pemantauan dan laporan yang dihasilkan oleh Analytics. Misalnya, Anda mungkin melihat perbedaan dalam hasil yang dilaporkan untuk error waktu tunggu—baik waktu tunggu backend (kode status HTTP 504 pada permintaan) maupun waktu tunggu klien (kode status HTTP 499). Data ini mungkin muncul dengan kode status 200 di laporan kustom Analytics, tetapi akan muncul dengan kode status 504 atau 499 di laporan kustom Monitoring.Pemantauan API
API Monitoring memberikan insight real-time tentang performa API, dan membantu Anda mendiagnosis serta memperbaiki masalah dengan cepat agar API Anda tetap berfungsi sebagaimana mestinya.
Dengan Pemantauan API, Anda dapat:
- Meningkatkan ketersediaan API dan mengurangi rata-rata waktu untuk mendiagnosis (MTTD).
- Lakukan tindakan yang sesuai berdasarkan peringatan kontekstual sebelum konsumen terpengaruh.
- Manfaatkan kode kesalahan Apigee untuk mempercepat diagnosis.
- Isolasi area masalah dengan cepat untuk mendiagnosis masalah error, performa, dan latensi serta sumbernya.
Edge API Analytics
Edge API Analytics mengumpulkan dan menganalisis informasi yang mengalir melalui API. Analytics API mengambil informasi seperti:
- Tren traffic API Anda dari waktu ke waktu
- Aplikasi mana yang paling sering Anda gunakan
- Siapa developer teratas Anda
- Metode API mana yang paling populer
- Kapan waktu respons API tercepat/terlambat
- Di mana secara geografis Anda melihat traffic API terbanyak
Data yang dikumpulkan oleh API Analytics
Analytics API mengumpulkan dan menganalisis spektrum data yang luas yang mengalir di seluruh API. Misalnya, saat API Anda di-deploy, Analytics terus-menerus mencatat jumlah pesan yang diterima, jumlah developer, waktu respons, error, jumlah aplikasi yang digunakan, ukuran permintaan, dan banyak data lainnya.
Untuk pengantar yang baik tentang metrik dan cara menggunakannya, lihat Menggunakan API metrik untuk mengukur performa program API. Untuk daftar lengkap metrik, lihat Referensi metrik, dimensi, dan filter Analytics.
Mengumpulkan metrik kustom
Anda juga dapat mengumpulkan metrik kustom menggunakan kebijakan StatisticsCollector. Kebijakan StatisticsCollector dapat menulis informasi dari header permintaan, payload XML/JSON, parameter kueri, URI, dan lokasi lainnya ke Server Analytics untuk dianalisis dan menghasilkan laporan.
Mengakses data Analytics
Setelah dibuat, Anda dapat mengakses metrik standar dan metrik kustom menggunakan alat visualisasi Analytics API, termasuk Dasbor, laporan kustom, dan GeoMap. Untuk mengetahui informasi selengkapnya tentang alat visualisasi yang disediakan oleh Analisis API, lihat Dasbor Analytics. Untuk mengetahui informasi selengkapnya tentang laporan kustom, lihat Membuat laporan kustom.
Membandingkan Pemantauan API dan Analisis API
Developer API menggunakan API Monitoring dan API Analytics. Salah satu perbedaan utama antara keduanya adalah mekanisme pemberitahuan yang ada di Pemantauan API. Pemberitahuan memungkinkan tim operasi Anda merespons masalah pada API secara real time untuk memastikan bahwa API Anda tersedia dan mencapai performa yang diharapkan.
Kondisi pemberitahuan menentukan kode status (2xx/4xx/5xx), latensi, dan nilai minimum kode kesalahan tertentu yang jika terlampaui akan memicu pemberitahuan visual di UI dan mengirim notifikasi melalui berbagai saluran, seperti email, Slack, PagerDuty, atau webhook. Anda dapat menyiapkan pemberitahuan di tingkat lingkungan, proxy API atau layanan target, atau wilayah.
Setelah pemberitahuan dipicu, tim operasi Anda dapat menggunakan UI Pemantauan API untuk menyelidiki masalah dan melihat perincian akar masalahnya. Kemudian, Anda dapat membuat laporan kustom yang mencakup informasi standar tentang pemberitahuan, seperti:
- Total waktu respons
- Waktu respons target
- Error proxy
- Error target
- UUID Permintaan
- dan banyak lagi
Analisis API dirancang untuk merekam berbagai data yang akan digunakan oleh beberapa tim. Contoh:
- Tim operasi dapat menggunakan data Analytics untuk mengidentifikasi periode traffic tinggi atau rendah sehingga mereka dapat meningkatkan skala atau memperkecil skala layanan Anda untuk memenuhi perubahan permintaan.
- Tim pemasaran dapat menggunakan data Analytics untuk menentukan pola penggunaan pelanggan yang diidentifikasi oleh masing-masing API, aplikasi, pelanggan, atau data lainnya.
- Semua tim dapat mengakses data kustom yang dikumpulkan dari permintaan untuk melacak informasi tertentu seperti nilai header, parameter kueri, atau payload permintaan.