Ringkasan Analisis API

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

Topik ini memperkenalkan Analisis Edge API.

Video: Tonton video singkat untuk mengetahui ringkasan layanan Analisis Edge API.

Meningkatkan API Anda melalui analisis

Analisis Edge API mengumpulkan dan menghitung banyak informasi yang mengalir melalui proxy API. Anda dapat memvisualisasikan data ini dengan grafik dan diagram di UI Edge, atau mendownload data mentah untuk analisis offline menggunakan API pengelolaan Edge.

Analytics membantu Anda menjawab pertanyaan umum, seperti:

  • Bagaimana traffic API saya menjadi tren dari waktu ke waktu?
  • Metode API mana yang paling populer?
  • Siapa developer teratas saya?
  • Kapan waktu respons API tercepat? Paling lambat?
  • Secara geografis, di mana saya melihat traffic API terbanyak?

Jawaban atas pertanyaan seperti ini membantu Anda meningkatkan API, memecahkan masalah, dan membuat keputusan bisnis yang lebih baik terkait program API.

API Analytics membantu semua orang meningkatkan

Melalui proses pengumpulan, analisis, dan visualisasi data yang berkelanjutan, Edge API Analytics membantu tim API Anda meningkatkan kualitas API dan membantu developer aplikasi meningkatkan kualitas aplikasi mereka:

alt_text
  • Tim API - Tim API sedang memanfaatkan sistem internal untuk membuat API yang menarik. Tim API ingin mengetahui performa program API secara keseluruhan, performa setiap API, dan cara meningkatkan API-nya.
  • Developer Aplikasi - Dengan berbagi informasi analisis dengan developer aplikasi, Anda mendapatkan aplikasi yang lebih baik. Developer ini berinovasi dengan API Anda dan membangun aplikasi kreatif yang membantu meningkatkan pendapatan perusahaan Anda. Analytics membantu developer aplikasi mengetahui performa aplikasi mereka dan seberapa besar kontribusi mereka terhadap pendapatan perusahaan Anda. Developer aplikasi ingin tahu cara meningkatkan kualitas aplikasi mereka.
  • Tim Operasi - Tim operasi ingin memahami pola traffic dan mengantisipasi kapan harus menambahkan resource backend atau melakukan penyesuaian penting lainnya.
  • Pemilik Bisnis - Pemilik bisnis ingin melihat hasil investasi API mereka dan ke mana berinvestasi API di masa depan.

Jenis data apa yang dikumpulkan dan dianalisis?

Analisis Edge API mengumpulkan dan menganalisis spektrum data yang luas yang mengalir di seluruh proxy API seperti:

  • Waktu respons
  • Latensi permintaan
  • Ukuran permintaan
  • Error target
  • Nama produk API
  • Alamat email developer
  • Nama aplikasi
  • Banyak lainnya

Untuk daftar lengkap data yang dikumpulkan oleh API Analytics, lihat Referensi metrik, dimensi, dan filter Analytics.

Bagaimana cara mengumpulkan data analisis kustom?

Edge mengumpulkan banyak data secara native. Anda juga mungkin ingin mengumpulkan data analisis kustom khusus untuk proxy, aplikasi, produk, atau developer API Anda. Misalnya, Anda mungkin ingin mengumpulkan data analisis dari parameter kueri, header permintaan, isi permintaan dan respons, atau variabel yang Anda tentukan dalam API.

Anda mengumpulkan data analisis kustom menggunakan kebijakan Statisticscollector. Setelah data kustom diekstrak, Anda dapat menggunakan UI atau API analisis untuk memeriksa data. Lihat Menganalisis konten pesan API menggunakan analisis kustom untuk mengetahui contoh lengkap yang menunjukkan cara mengumpulkan data analisis kustom.

Perbedaan antara data Analytics dan data Pemantauan API

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.

Kapan dan berapa lama data analisis saya akan tersedia?

Ada dua interval waktu yang mengontrol kapan dan berapa lama Anda dapat melihat data analisis:

  • Interval penundaan data - Setelah panggilan dilakukan ke proxy API, perlu waktu hingga 10 menit agar data dapat diakses untuk ditampilkan atau melalui panggilan API pengelolaan.
  • Retensi data - Durasi waktu penyimpanan data analisis oleh Edge berbeda menurut paket. Bergantung pada rencana Anda, data analisis mungkin tersedia selama 30, 60, 90, atau 365 hari terakhir.

Bagaimana cara mengakses data analisis saya?

Analisis Edge API menyediakan alat visualisasi data yang terintegrasi ke dalam UI Edge. Alat ini mencakup dasbor analisis standar dan laporan kustom yang menampilkan data dalam grafik dan diagram, serta memungkinkan Anda melihat perincian untuk melihat data yang dikelompokkan ke dalam berbagai dimensi (seperti berdasarkan proxy API, alamat IP, atau kode status HTTP).

Selain itu, Anda dapat mendownload data analisis menggunakan Edge Management API. Setelah didownload, Anda dapat mengimpor data tersebut ke alat visualisasi data atau sistem analisis Anda sendiri.

Dasbor Analytics

UI Edge menyediakan serangkaian dasbor standar yang dapat Anda gunakan untuk melihat data analisis. Misalnya, gambar berikut menampilkan dasbor Performa Proxy:

Dasbor ini mencakup diagram untuk:

  • Total Traffic - Jumlah total permintaan API yang diterima oleh Edge untuk lingkungan API di organisasi.
  • Kesuksesan Traffic - Total jumlah permintaan yang menghasilkan respons yang berhasil. Respons error tidak dihitung.
  • Error Traffic - Jumlah total semua permintaan API yang gagal; yaitu, permintaan tidak memberikan respons. Jumlah ini mencakup error Proxy (sisi Apigee) dan error Target (layanan backend).
  • TPS Rata-rata - Jumlah rata-rata permintaan API dan respons yang dihasilkan per detik.

Dasbor standar tambahan mencakup:

Untuk informasi lebih lanjut tentang dasbor standar ini, lihat Menggunakan dasbor analisis.

Laporan kustom

Laporan kustom memungkinkan Anda melihat perincian metrik API tertentu dan melihat data persis yang ingin Anda lihat. Anda dapat membuat laporan kustom menggunakan data analisis apa pun yang terintegrasi di Edge atau data analisis kustom yang dikumpulkan oleh kebijakan Statisticscollector.

Saat membuat laporan kustom, Anda memilih data yang ingin dilihat (metrik), mengelompokkan data secara bermakna (dimensi), dan secara opsional membatasi data yang ditampilkan berdasarkan karakteristik data tertentu (pemfilteran).

Anda juga dapat menetapkan jenis diagram yang ditampilkan dalam laporan kustom sebagai diagram kolom atau garis. Gambar berikut menampilkan contoh diagram untuk transaksi per detik yang dikelompokkan berdasarkan proxy API:

  • Kolom - Setiap proxy API diwakili oleh kolom yang berbeda:

    Diagram kolom kustom

  • Baris - Setiap proxy API dinyatakan dalam baris yang berbeda:

    Diagram garis kustom

Untuk mengetahui informasi selengkapnya, lihat Membuat dan mengelola laporan kustom.

Analytics API

Gunakan Edge management API untuk mendownload data analisis. Misalnya, Anda dapat menggunakan API untuk membuat alat visualisasi Anda sendiri yang dapat disematkan di portal atau aplikasi kustom.

Berikut adalah contoh panggilan API guna mengambil data analisis untuk proxy API:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

Panggilan ini menampilkan:

  • Jumlah permintaan (jumlah pesan) per proxy API
  • Selama periode 24 jam
  • Dikelompokkan menurut jam

Parameter kueri timeRange menentukan jangka waktu dalam formulir:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Perhatikan %20 sebelum HH:MM. Parameter timeRange memerlukan karakter spasi yang dienkode URL sebelum HH:MM, atau karakter +, seperti pada: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Untuk informasi selengkapnya, lihat Menggunakan API metrik untuk mengukur performa program API.

Mengekspor data analisis ke Google Cloud

Anda dapat menggunakan Edge Management API untuk mengekspor semua data analisis sepanjang hari dari Edge ke repositori data Anda sendiri, seperti Google Cloud Storage atau BigQuery. Selanjutnya, Anda dapat memanfaatkan kemampuan kueri dan machine learning yang andal yang ditawarkan oleh Google Cloud BigQuery dan TensorFlow untuk melakukan analisis data Anda sendiri.

Untuk mengetahui detailnya, lihat Mengekspor data dari analisis.

Bagaimana cara berbagi data dengan developer aplikasi?

Ketika Anda menganggap developer aplikasi sebagai pelanggan, Anda harus memastikan mereka memiliki alat dan informasi yang tersedia untuk mereka guna memanfaatkan API Anda sebaik mungkin.

alt_text

Developer aplikasi tidak hanya mementingkan kualitas aplikasi mereka, mereka juga sangat tertarik dengan API Anda. Portal developer berbasis Drupal menyertakan halaman Performa Aplikasi opsional yang dirancang untuk memberi developer aplikasi akses ke metrik penting untuk aplikasi mereka. Halaman ini memberikan informasi kepada developer tentang:

  • Error: Error API mana yang terlihat oleh aplikasi saya?
  • Performa: Apakah saat ini API-nya lambat? Metode API mana yang biasanya lambat atau lambat saat ini?
  • Ketersediaan: Apakah saat ini API sedang aktif atau tidak?
  • Kuota: Apakah API Anda memiliki kuota? Sebagai developer aplikasi, apa yang saya lakukan terhadap kuota?

Untuk mengetahui informasi selengkapnya, lihat:

Selain itu, Anda dapat membagikan analisis dengan developer dengan:

Bagaimana cara menghasilkan data analisis yang lengkap?

Apa yang kami maksud dengan analisis lengkap? Misalnya, Anda dapat membuat proxy API dan Edge akan mengumpulkan data analisis tentang proxy tersebut. Namun, bagaimana dengan metrik untuk developer atau aplikasi yang memanggil proxy API? Jika Edge tidak mengetahui siapa yang melakukan panggilan API, Edge tidak dapat mengumpulkan data tersebut.

Beberapa langkah diperlukan agar Edge dapat mengetahui developer dan aplikasi developer mana yang memanggil proxy API Anda. Berikut adalah daftar langkah-langkah tersebut beserta tautan ke informasi yang lebih detail:

  1. Buat satu atau beberapa produk API, yang merupakan pengelompokan proxy API bersama dengan paket layanan. Lihat Mengelola produk API.
  2. Mendaftarkan developer aplikasi ke Edge. Lihat Mendaftarkan developer aplikasi.
  3. Daftarkan aplikasi dan buat kunci API untuk developer Anda. Lihat Mendaftarkan aplikasi dan mengelola kunci API.
  4. Tambahkan kebijakan keamanan ke proxy API Anda yang memverifikasi kunci API dan/atau token keamanan. Lihat topik berikut:Memverifikasi kebijakan Kunci API, kebijakan OAuthV2, dan Memverifikasi kebijakan JWT.
  5. Jika menggunakan Edge Microgateway, pastikan Anda telah mengaktifkan plugin analisis (yang diaktifkan secara default). Jika plugin analisis dinonaktifkan, Edge Microgateway tidak akan mengirimkan data analisis ke analisis Edge.

Tutorial berikut akan memandu Anda melalui langkah-langkah penting yang memungkinkan Anda melihat analisis untuk developer dan aplikasi: Mengamankan API dengan mewajibkan kunci API dan Mengamankan API dengan OAuth.

Membandingkan Analisis API dengan Monitoring API

Anda dapat memanfaatkan API Monitoring Edge dan API Analytics. API Monitoring memeriksa data analisis untuk memberikan insight kontekstual real-time tentang performa API, sehingga Anda dapat mendiagnosis masalah dengan cepat dan memfasilitasi tindakan perbaikan untuk kelangsungan bisnis. Pemantauan API dirancang untuk menemukan titik masalah di API dan backend Anda dengan cepat. Analisis API dirancang untuk menangkap berbagai data analisis untuk digunakan oleh beberapa tim yang berbeda, tetapi data tersebut biasanya digunakan untuk analisis dalam skenario non-realtime.

Salah satu perbedaan utama antara API Monitoring dan API Analytics adalah mekanisme pemberitahuan yang terintegrasi ke dalam API Monitoring. Dengan peringatan, Anda menentukan kode status HTTP (2xx/4xx/5xx), latensi, atau nilai minimum kode kesalahan yang, jika terlampaui, akan memicu notifikasi pemberitahuan kepada Tim Operasi Anda. Notifikasi pemberitahuan dapat dikirim melalui berbagai saluran, seperti email, Slack, pager, atau webhook, sehingga Anda dapat merespons masalah dengan segera.

Lihat Membandingkan Pemantauan API dengan Analisis Edge API untuk mengetahui perbandingan yang lebih mendetail antara layanan-layanan ini.

Informasi selengkapnya