Membandingkan Pemantauan API dengan Edge Analytics

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Bagian ini membandingkan API Monitoring dengan Edge Analytics. Meskipun API Monitoring dan Edge Analytics memungkinkan Anda mengumpulkan dan melihat data API, keduanya memiliki tujuan yang berbeda:

  • Tujuan dari Pemantauan API adalah untuk memastikan bahwa API Anda aktif dan berjalan seperti yang diinginkan. Untuk tujuan ini, Anda ingin melihat data terbaru yang tersedia. Pemantauan API memberikan data yang sangat mendekati real-time, dan memungkinkan Anda membuat pemberitahuan yang akan memberi tahu Anda jika terjadi masalah.
  • Sasaran Edge Analytics adalah memahami perilaku jangka panjang API Anda, sehingga Anda dapat memastikan bahwa API tersebut mendukung persyaratan bisnis Anda, atau membuat perubahan jika diperlukan. Untuk tujuan ini, melihat data real-time tidak terlalu 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 sebagian kecil data Analytics.

Perbedaan antara data Pemantauan API dan data Analytics

Bagian ini menjelaskan beberapa perbedaan kecil antara data yang dikumpulkan oleh Edge Analytics versus API Monitoring. Karena Pemantauan API dan Analytics menggunakan pipeline data yang berbeda, Anda mungkin melihat perbedaan kecil antara laporan kustom yang dibuat oleh Monitoring dan laporan yang dihasilkan oleh Analytics. Misalnya, Anda mungkin melihat perbedaan dalam hasil yang dilaporkan untuk error waktu tunggu—waktu tunggu backend (kode status HTTP 504 pada permintaan) dan waktu tunggu klien (kode status HTTP 499). Masalah ini dapat muncul dengan kode status 200 dalam laporan kustom Analytics, tetapi akan muncul dengan kode status 504 atau 499 dalam laporan kustom Monitoring.

Pemantauan API

Pemantauan API memberikan insight real-time tentang performa API, serta membantu Anda mendiagnosis dan memperbaiki masalah dengan cepat agar API Anda tetap berfungsi sebagaimana mestinya.

Dengan Pemantauan API, Anda dapat:

  • Meningkatkan ketersediaan API dan mengurangi mean-time-to-diagnosis (MTTD).
  • Ambil tindakan yang sesuai berdasarkan peringatan kontekstual sebelum konsumen terkena dampak.
  • Manfaatkan kode kesalahan Apigee untuk mempercepat diagnosis.
  • Isolasi area masalah dengan cepat untuk mendiagnosis masalah error, performa, dan latensi serta sumbernya.

Analisis Edge API

Edge API Analytics mengumpulkan dan menganalisis informasi yang mengalir melalui API. Analytics API mengambil informasi seperti:

  • Tren traffic API Anda dari waktu ke waktu
  • Apa aplikasi teratas Anda
  • Siapa developer teratas Anda
  • Metode API yang paling populer
  • Kapan waktu respons API tercepat/paling lambat
  • Lokasi geografis tempat Anda melihat traffic API terbanyak

Data yang dikumpulkan oleh API Analytics

Analisis 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 metrik yang baik 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 analisis dan pembuatan laporan.

Mengakses data Analytics

Setelah dibuat, Anda dapat mengakses metrik standar dan metrik kustom dengan menggunakan alat visualisasi API Analytics, termasuk Dasbor, laporan kustom, dan GeoMap. Untuk informasi lebih lanjut tentang alat visualisasi yang disediakan oleh API Analytics, lihat dasbor Analytics. Untuk informasi selengkapnya tentang laporan kustom, lihat Membuat laporan kustom.

Membandingkan API Monitoring dan API Analytics

Developer API menggunakan API Monitoring dan API Analytics. Salah satu perbedaan utama di antara keduanya adalah mekanisme pemberitahuan yang terintegrasi dalam API Monitoring. Pemberitahuan memungkinkan tim operasi Anda merespons masalah pada API secara real time untuk memastikan API Anda tersedia dan berperforma seperti yang diharapkan.

Kondisi notifikasi menentukan kode status tertentu (2xx/4xx/5xx), latensi, dan batas kode kesalahan yang jika terlampaui akan memicu notifikasi 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 tingkat region.

Setelah pemberitahuan dipicu, tim operasi Anda dapat menggunakan UI Pemantauan API untuk menyelidiki masalah dan melihat perincian masalah utamanya. Selanjutnya, Anda dapat membuat laporan kustom yang menyertakan informasi standar tentang notifikasi, seperti:

  • Total waktu respons
  • Target waktu respons
  • Kesalahan proxy
  • Error target
  • Meminta UUID
  • banyak lagi

Analisis API dirancang untuk mengambil berbagai data untuk digunakan oleh beberapa tim. Contoh:

  • Tim operasi dapat menggunakan data Analytics untuk mengidentifikasi periode traffic tinggi atau rendah, sehingga mereka dapat meningkatkan atau menurunkan skala layanan Anda guna memenuhi permintaan yang terus berubah.
  • 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 spesifik seperti nilai header, parameter kueri, atau payload permintaan.