Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi
Apigee Edge.
Topik ini memperkenalkan Analisis API Apigee.
Video: Tonton video singkat tentang ringkasan layanan Analisis API Apigee.
Meningkatkan API Anda melalui analisis
Apigee API Analytics mengumpulkan dan menghitung banyak informasi yang mengalir melalui proxy API. Anda dapat memvisualisasikan data ini dengan grafik dan diagram di UI Apigee, atau mendownload data mentah untuk analisis offline menggunakan Apigee API.
Analytics membantu Anda menjawab pertanyaan umum, seperti:
- Bagaimana tren traffic API saya 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?
- Berapa banyak pendapatan yang dihasilkan transaksi Anda?
Anda dapat menganalisis data untuk nama Host tertentu atau untuk seluruh lingkungan.
Jawaban atas pertanyaan seperti ini membantu Anda meningkatkan API, memecahkan masalah, dan membuat keputusan bisnis yang lebih baik terkait program API Anda.
API Analytics membantu semua orang meningkatkan
Melalui proses pengumpulan, analisis, dan visualisasi data yang berkelanjutan, Apigee API Analytics membantu tim API Anda meningkatkan kualitas API dan membantu developer aplikasi meningkatkan kualitas aplikasi mereka:
- 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 mereka.
- Developer Aplikasi - Dengan berbagi informasi analisis dengan developer aplikasi, Anda mendapatkan aplikasi yang lebih baik. Para developer ini berinovasi dengan API Anda dan membuat aplikasi kreatif yang membantu meningkatkan pendapatan bagi perusahaan Anda. Analytics membantu developer aplikasi mengetahui performa aplikasi dan besarnya 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 bagaimana hasil investasi API mereka dan di mana menginvestasikan dana API di masa mendatang.
Bagaimana cara mulai menggunakan Apigee API Analytics?
Jenis organisasi Apigee yang Anda gunakan akan menentukan langkah-langkah yang diperlukan untuk memulai Apigee API Analytics. Jika tidak yakin apakah Anda menggunakan organisasi Apigee Langganan atau Bayar sesuai penggunaan, hubungi administrator organisasi Apigee Anda.
Menggunakan Analytics Apigee API dengan organisasi Langganan
Jika Anda adalah pelanggan Langganan Apigee, akses ke Analytics API Apigee disertakan dalam hak langganan Anda dan otomatis diaktifkan untuk setiap lingkungan Apigee Anda.
Anda dapat mengakses data analisis untuk organisasi Langganan menggunakan UI Apigee, UI Apigee di Konsol Cloud, atau Apigee API. Untuk mengetahui detail selengkapnya, lihat Cara mengakses data analisis saya.
Menggunakan Analisis API Apigee dengan organisasi Bayar sesuai penggunaan
Jika Anda adalah pelanggan Pay-as-you-go, Anda harus mengaktifkan Apigee API Analytics sebagai add-on berbayar untuk mulai menggunakan data analisis. Untuk informasi selengkapnya tentang cara mengaktifkan add-on Analisis Apigee API untuk lingkungan Apigee Menengah atau Komprehensif, lihat Mengelola add-on Analytics Apigee API.
Setelah add-on Analytics Apigee API diaktifkan di lingkungan, Anda dapat mengakses data analisis dan mengelola add-on Analytics Apigee API menggunakan UI Apigee di Konsol Cloud atau Apigee API. Untuk mengetahui detail selengkapnya, lihat Cara mengakses data analisis saya. Data analisis dan pengelolaan add-on tidak tersedia di UI Apigee klasik untuk organisasi Bayar sesuai penggunaan.
Jenis data apa yang dikumpulkan dan dianalisis?
Apigee API Analytics 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
- Pendapatan transaksi
Untuk listingan lengkap data yang dikumpulkan oleh API Analytics, lihat Referensi metrik, dimensi, dan filter Analytics.
Bagaimana cara mengumpulkan data analisis kustom?
Apigee secara native mengumpulkan data dalam jumlah besar. Anda juga dapat mengumpulkan data analisis kustom khusus untuk proxy, aplikasi, produk, atau developer API. Misalnya, Anda mungkin ingin mengumpulkan data analisis dari parameter kueri, header permintaan, isi permintaan dan respons, atau variabel yang Anda tentukan dalam API.
Anda dapat mengumpulkan data analisis kustom dengan kebijakan DataCapture, lalu menggunakan UI atau API analisis untuk memeriksa data yang dikumpulkan.
Kapan dan untuk 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.
- Ketersediaan Analytics - Durasi data analisis (yang mencakup data Monetisasi dan Sense, jika ada) disediakan oleh Apigee berbeda-beda menurut paket. Bergantung pada paket Anda, data analisis mungkin tersedia selama 30 hari, 90 hari, atau 14 bulan terakhir.
Retensi analisis saat menggunakan add-on Analytics Apigee API
Jika memiliki organisasi Bayar sesuai penggunaan, Anda dapat mengaktifkan add-on Analytics Apigee API di tingkat lingkungan. Setelah add-on diaktifkan untuk suatu lingkungan, data analisis untuk lingkungan tersebut akan disimpan selama 14 bulan. Anda dapat mengakses data analisis historis lingkungan dari halaman Metrik API di konsol selama add-on diaktifkan.
Jika Anda menonaktifkan add-on Analisis Apigee API untuk lingkungan di organisasi Bayar sesuai penggunaan, data analisis untuk lingkungan tersebut akan dihapus setelah 30 hari. Jika Anda mengaktifkan kembali add-on di lingkungan yang sama dalam waktu 30 hari sejak penonaktifan, Anda dapat memperoleh kembali akses ke data analisis untuk lingkungan tersebut melalui periode retensi data selama 14 bulan. Data tidak akan dipulihkan jika add-on diaktifkan kembali untuk lingkungan setelah 30 hari.
Jika Anda ingin menyimpan data analisis untuk lingkungan apa pun di organisasi Bayar sesuai penggunaan setelah periode retensi data 14 bulan, sebaiknya ekspor dan simpan data di lokasi lain. Anda juga dapat mengekspor data Analytics sebelum menonaktifkan add-on Analytics Apigee API, atau dalam periode 30 hari setelah penonaktifan. Untuk informasi selengkapnya, lihat Mengekspor data dari Analytics.
Di mana data analisis saya disimpan dan diproses?
Tempat data analisis disimpan dan diproses ditentukan oleh region analisis yang Anda tentukan saat menginstal Apigee:
- Jika Anda adalah pelanggan Langganan dan menginstal Apigee menggunakan wizard penyediaan Apigee, Anda dapat menentukan region analisis pada langkah 1 Membuat organisasi, saat menetapkan Region hosting Analytics.
- Jika Anda adalah pelanggan Bayar sesuai penggunaan dan menginstal Apigee menggunakan konsol Google Cloud, Anda telah menentukan region analisis di langkah 3 Create an organization, saat menetapkan region hosting Analytics.
- Jika menginstal Apigee dari command line sebagai pelanggan Langganan atau Bayar sesuai penggunaan, Anda dapat menentukan region analisis saat menentukan variabel lingkungan
ANALYTICS_REGION.
Data Analytics disimpan dan diproses sebagai berikut:
- Untuk wilayah analisis yang tidak berada di AS atau Uni Eropa, data analisis disimpan dan diproses di wilayah analisis.
- Untuk wilayah analisis di Amerika Serikat atau Uni Eropa, data masing-masing disimpan di multi-region Amerika Serikat atau Uni Eropa untuk ketersediaan yang lebih tinggi.
Bagaimana cara mengakses data Analytics saya?
Analisis API Apigee menyediakan alat visualisasi data yang dibangun ke dalam UI Apigee. 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).
Anda juga dapat mendownload data analisis menggunakan Apigee API. Setelah didownload, Anda dapat mengimpor data tersebut ke alat visualisasi data atau sistem analisis Anda sendiri.
Dasbor Analytics
UI Apigee menyediakan serangkaian dasbor standar yang dapat Anda gunakan untuk melihat data analisis.
Apigee di Konsol Cloud
Untuk membuka dasbor Analytics (untuk organisasi Bayar sesuai penggunaan atau Langganan):
- Buka UI Apigee di Konsol Cloud di browser.
- Pilih Analytics > Metrik API.
Pilih dari tab berikut untuk melihat dasbor:
Untuk informasi selengkapnya, lihat Menggunakan dasbor analisis.
Apigee Klasik
Untuk membuka dasbor Analytics (khusus organisasi Langganan):
- Buka UI Apigee di browser.
- Pilih Analyze > API Metrics.
- Pilih salah satu dasbor berikut:
Selain itu, Anda juga dapat menggunakan dasbor berikut:
- Di bagian Analisis > Developer:
- Di bagian Analisis > Pengguna Akhir:
Untuk informasi selengkapnya, 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 salah satu data analisis yang disertakan dalam Apigee.
Saat membuat laporan kustom, Anda memilih data yang ingin dilihat (metrik), mengelompokkan data dengan cara yang bermakna (dimensi), dan jika perlu, 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 menunjukkan contoh diagram untuk transaksi per detik yang dikelompokkan oleh proxy API:
Kolom - Setiap proxy API diwakili oleh kolom berbeda:
Baris - Setiap proxy API dinyatakan sebagai baris yang berbeda:
Untuk informasi selengkapnya, lihat Membuat dan mengelola laporan kustom.
Analytics API
Gunakan Apigee 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 untuk mengambil data analisis untuk proxy API:
curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \ -H "Authorization: Bearer $TOKEN"
Panggilan ini menampilkan:
- Jumlah permintaan (jumlah pesan) per proxy API
- Untuk periode 24 jam
- Dikelompokkan menurut jam
Parameter kueri timeRange menentukan jangka waktu dalam bentuk:
?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM
Perhatikan %20 sebelum HH:MM. Parameter timeRange memerlukan
karakter spasi berenkode URL sebelum HH:MM, atau karakter +, seperti dalam:
MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.
Untuk informasi selengkapnya, lihat Menggunakan API metrik.
Mengekspor data analisis ke Google Cloud Platform
Anda dapat menggunakan Apigee API untuk mengekspor semua data analisis sepanjang hari dari Apigee ke repositori data Anda sendiri, seperti Google Cloud Storage atau BigQuery. Selanjutnya, Anda dapat memanfaatkan kemampuan kueri dan machine learning canggih yang ditawarkan oleh Google Cloud BigQuery dan TensorFlow untuk melakukan analisis data Anda sendiri.
Untuk informasi selengkapnya, lihat Mengekspor data dari Analytics.
Bagaimana cara berbagi data dengan developer aplikasi?
Saat menganggap developer aplikasi sebagai pelanggan, Anda harus memastikan bahwa mereka memiliki alat dan informasi yang tersedia untuk memanfaatkan API Anda sebaik mungkin.
Developer aplikasi tidak hanya mementingkan kualitas aplikasi, tetapi 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 dilihat aplikasi saya?
- Performa: Apakah API lambat? Metode API mana yang biasanya lambat atau lambat saat ini?
- Ketersediaan: Apakah API naik atau turun?
- Kuota: Apakah API Anda memiliki kuota? Dan sebagai developer aplikasi, bagaimana performa saya terhadap kuota?
Untuk mengetahui informasi selengkapnya, lihat Memantau aplikasi dalam dokumentasi Drupal 8.
Selain itu, Anda dapat membagikan analisis kepada developer dengan:
- Membuat laporan kustom dan membagikannya dengan developer aplikasi Anda. Untuk informasi selengkapnya, lihat Membuat dan mengelola laporan kustom.
- Menggunakan API metrik untuk mengambil data selama jangka waktu yang lebih panjang untuk dibagikan kepada developer aplikasi secara offline. Untuk informasi selengkapnya, lihat Menggunakan Metrics API.
Bagaimana cara menghasilkan data analisis yang lengkap?
Apa yang kami maksud dengan analisis lengkap? Misalnya, Anda dapat membuat proxy API dan Apigee akan mengumpulkan data analisis tentang proxy tersebut. Namun, bagaimana dengan metrik untuk developer atau aplikasi yang memanggil proxy API? Jika Apigee tidak tahu siapa yang melakukan panggilan API, Apigee tidak dapat mengumpulkan data tersebut.
Beberapa langkah diperlukan agar Apigee dapat mengetahui developer mana dan aplikasi developer mana yang memanggil proxy API Anda. Berikut adalah daftar langkah-langkah tersebut beserta tautan ke informasi yang lebih detail:
- Buat satu atau beberapa produk API, yang merupakan pengelompokan proxy API bersama dengan paket layanan. Lihat Mengelola produk API.
- Mendaftarkan developer aplikasi ke Apigee. Lihat Mendaftarkan developer aplikasi.
- Mendaftarkan aplikasi dan mengelola kunci API untuk developer Anda. Lihat Mendaftarkan aplikasi dan mengelola kunci API.
- Tambahkan kebijakan keamanan ke proxy API Anda yang memverifikasi kunci API dan/atau token keamanan. Lihat topik berikut: kebijakan VerifyAPIKey, kebijakan OAuthV2, dan kebijakan VerifyJWT.
Tutorial berikut akan memandu Anda melalui langkah-langkah yang diperlukan untuk melihat analisis untuk developer dan aplikasi: Mengamankan API dengan mewajibkan kunci API dan Mengamankan API dengan OAuth.