Membandingkan Pemantauan API dengan Edge Analytics

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 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.
  • Tujuan Edge Analytics adalah untuk memahami perilaku API Anda dalam jangka panjang, sehingga Anda dapat memastikan API tersebut mendukung persyaratan bisnis Anda, atau melakukan perubahan jika diperlukan. Untuk tujuan ini, data real-time tidak terlalu penting untuk dilihat. Akibatnya, data Analytics sedikit tertunda, meskipun biasanya tidak lebih dari 10 menit.

Perhatikan bahwa data Pemantauan API, yang sebagian besar terkait dengan kode error dan latensi, adalah sebagian kecil dari data Analytics.

Perbedaan antara data Pemantauan API dan data Analytics

Bagian ini menjelaskan beberapa perbedaan kecil antara data yang dikumpulkan oleh Edge Analytics dan Monitoring API. Karena Monitoring API dan Analytics menggunakan pipeline data yang berbeda, Anda mungkin melihat perbedaan kecil antara laporan kustom yang dihasilkan oleh Monitoring 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). Laporan 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

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

Pemantauan API memungkinkan Anda untuk:

  • Meningkatkan ketersediaan API dan mengurangi mean-time-to-diagnosis (MTTD).
  • Lakukan tindakan yang sesuai berdasarkan pemberitahuan kontekstual sebelum konsumen terpengaruh.
  • Manfaatkan kode error 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
  • Secara geografis, di mana Anda melihat traffic API terbanyak

Data yang dikumpulkan oleh Analytics API

Analisis API mengumpulkan dan menganalisis berbagai spektrum data 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 bagian data lainnya.

Untuk pengantar yang baik tentang metrik dan cara menggunakannya, lihat Menggunakan API metrik untuk mengukur performa program API. Untuk mengetahui listingan 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 menggunakan alat visualisasi Analytics API, termasuk Dasbor, laporan kustom, dan GeoMap. Untuk mengetahui informasi selengkapnya tentang alat visualisasi yang disediakan oleh Analytics 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 terintegrasi dengan Pemantauan API. Notifikasi memungkinkan tim operasi Anda merespons masalah pada API secara real time untuk memastikan bahwa API tersedia dan berperforma seperti yang diharapkan.

Kondisi pemberitahuan menentukan kode status (2xx/4xx/5xx), latensi, dan nilai minimum kode error 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 Monitoring API untuk menyelidiki masalah dan melihat akar masalahnya. Kemudian, Anda dapat membuat laporan kustom yang menyertakan informasi standar tentang pemberitahuan, seperti:

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

Analytics API dirancang untuk mengambil 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 menskalakan layanan Anda ke atas atau ke bawah untuk memenuhi permintaan yang 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 tertentu seperti nilai header, parameter kueri, atau payload permintaan.