Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Lihat
Dokumentasi Apigee Edge.
Topik ini memperkenalkan Analisis API Apigee.
Video: Tonton video singkat untuk mengetahui ringkasan layanan Analisis API Apigee.
Meningkatkan API Anda melalui analisis
Analisis API Apigee 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 mentahnya analisis offline secara 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 dapat melihat traffic API terbanyak?
- Berapa banyak pendapatan yang dihasilkan dari transaksi Anda?
Anda dapat menganalisis data untuk Nama host tertentu atau untuk seluruh lingkungan.
Jawaban atas pertanyaan seperti ini akan membantu Anda meningkatkan kualitas API, memecahkan masalah, dan keputusan bisnis yang terkait dengan program API Anda.
Analisis API membantu semua orang meningkatkan kualitas
Melalui proses pengumpulan, analisis, dan visualisasi data yang berkelanjutan, Analisis API Apigee membantu tim API Anda meningkatkan API mereka dan membantu developer aplikasi meningkatkan aplikasi mereka:
- Tim API - Tim API 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 membagikan informasi analisis kepada developer aplikasi, Anda mendapatkan aplikasi yang lebih baik. Developer ini berinovasi dengan API Anda dan membuat aplikasi kreatif yang membantu mendorong pendapatan bagi perusahaan Anda. Analytics membantu developer aplikasi mengetahui performa aplikasi mereka dan seberapa banyak mereka yang berkontribusi pada pendapatan perusahaan Anda. Developer aplikasi ingin mengetahui cara meningkatkan kualitas aplikasi mereka.
- Tim Operasi - Tim operasi ingin memahami pola lalu lintas dan mengantisipasi kapan harus menambahkan resource backend atau melakukan penyesuaian penting lainnya.
- Pemilik Bisnis - Pemilik bisnis ingin mengetahui cara Investasi API membuahkan hasil dan tempat untuk menginvestasikan dana API di masa mendatang.
Bagaimana cara mulai menggunakan Analisis API Apigee?
Jenis organisasi Apigee yang Anda gunakan akan menentukan langkah-langkah yang diperlukan untuk mulai menggunakan Analisis API Apigee. Jika tidak yakin apakah Anda menggunakan Apigee Langganan atau Bayar sesuai penggunaan organisasi, hubungi administrator organisasi Apigee Anda.
Menggunakan Analisis API Apigee dengan organisasi Langganan
Jika Anda adalah pelanggan Langganan Apigee, akses ke Analisis API Apigee yang disertakan dalam hak langganan dan otomatis diaktifkan untuk setiap lingkungan Apigee Anda.
Anda dapat mengakses data analisis untuk organisasi Langganan Anda menggunakan UI Apigee, UI Apigee di Konsol Cloud, atau Apigee API. Untuk 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 Analisis API Apigee sebagai add-on berbayar untuk mulai menggunakan data analisis. Untuk mengetahui informasi lebih lanjut tentang cara mengaktifkan add-on Analisis API Apigee untuk Apigee Menengah atau Komprehensif lingkungan, lihat Kelola add-on Analisis Apigee API.
Setelah add-on Analisis Apigee API diaktifkan di lingkungan, Anda dapat mengakses data analisis dan kelola add-on Analisis API Apigee menggunakan UI Apigee di Konsol Cloud, atau API Apigee. Untuk 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 atau ID AppGroup
- Nama aplikasi
- Pendapatan transaksi
Untuk melihat daftar lengkap data yang dikumpulkan oleh Analytics API, baca artikel referensi metrik, dimensi, dan filter Analytics.
Bagaimana cara mengumpulkan data analisis kustom?
Apigee secara native mengumpulkan banyak data. Anda mungkin juga ingin mengumpulkan data analisis khusus yang spesifik ke 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 dapat mengumpulkan data analisis kustom dengan DataCapture, lalu gunakan UI atau API analisis untuk memeriksa data yang dikumpulkan.
Kapan dan berapa lama data analisis saya 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, diperlukan waktu hingga 10 menit agar data dapat diakses untuk tampilan atau melalui panggilan API.
- Ketersediaan Analytics - Durasi waktu data analisis (termasuk Monetisasi dan data Sense, jika ada) disediakan oleh Apigee berbeda-beda tergantung rencananya. Bergantung pada paket Anda, data analisis mungkin tersedia selama 30 hari, 90 hari, atau 14 bulan terakhir.
Retensi Analytics saat menggunakan add-on Analisis Apigee API
Jika memiliki organisasi Bayar sesuai penggunaan, Anda dapat mengaktifkan add-on Apigee API Analytics di tingkat lingkungan. Setelah add-on diaktifkan untuk lingkungan, data analisis untuk lingkungan dipertahankan selama 14 bulan. Anda dapat mengakses data analisis historis lingkungan dari Metrik API di konsol selama add-on diaktifkan.
Jika Anda menonaktifkan add-on Apigee API Analytics untuk lingkungan di organisasi Bayar sesuai penggunaan, data analisis untuk lingkungan tersebut dihapus setelah 30 hari. Jika Anda mengaktifkan kembali add-on dengan cara dalam waktu 30 hari setelah penonaktifan, Anda dapat memperoleh kembali akses ke data analisis untuk lingkungan melalui periode retensi data 14 bulan. Tidak ada data yang dipulihkan jika add-on diaktifkan kembali untuk lingkungan tersebut setelah 30 hari.
Jika Anda ingin menyimpan data analisis untuk lingkungan apa pun dalam organisasi Bayar sesuai penggunaan setelah periode retensi data 14 bulan, sebaiknya Anda mengekspor dan menyimpan data Anda di lokasi lain. Anda juga dapat mengekspor data Analytics sebelum menonaktifkan Add-on Analisis API Apigee, 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 analytics region, yang Anda tentukan saat menginstal Apigee:
- Jika Anda adalah pelanggan Langganan dan menginstal Apigee menggunakan wizard penyediaan Apigee, Anda menentukan region analisis di Buat organisasi langkah 1, saat Anda menetapkan region hosting Analytics.
- Jika Anda adalah pelanggan Bayar sesuai penggunaan dan menginstal Apigee menggunakan konsol Google Cloud, Anda menentukan region analisis di Buat organisasi langkah 3, saat Anda menetapkan region hosting Analytics.
- Jika Anda menginstal Apigee dari command line sebagai pelanggan Langganan atau Bayar sesuai penggunaan, Anda menentukan region analisis saat
Anda mendefinisikan
variabel lingkungan
ANALYTICS_REGION.
Data Analytics disimpan dan diproses sebagai berikut:
- Untuk wilayah analisis yang tidak berada di Amerika Serikat atau Uni Eropa, data analisis disimpan dan diproses di region Analytics.
- Untuk wilayah analisis di AS atau Uni Eropa, data disimpan di Multi-region di AS atau UE, untuk ketersediaan yang lebih tinggi.
Bagaimana cara mengakses data analisis saya?
Apigee API Analytics menyediakan alat visualisasi data yang terintegrasi dalam UI Apigee. Alat-alat ini mencakup dasbor analisis standar dan laporan kustom yang menampilkan data dalam grafik dan diagram dan memungkinkan Anda lihat perincian untuk melihat data yang dikelompokkan ke dalam berbagai dimensi (misalnya menurut proxy API, alamat IP, atau kode status HTTP).
Anda juga dapat mendownload data analisis menggunakan Apigee API. Setelah diunduh, mengimpor data itu ke dalam alat visualisasi data atau sistem analitik Anda sendiri.
Dasbor Analytics
UI Apigee menyediakan kumpulan 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 untuk organisasi Langganan):
- Buka UI Apigee di browser.
- Pilih Analyze > Metrik API.
- 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 yang tepat yang ingin Anda lihat. Anda dapat membuat laporan kustom menggunakan salah satu data analisis yang tersedia di Apigee.
Saat membuat laporan kustom, pilih data yang ingin dilihat (metrik), lalu kelompokkan data tersebut cara yang bermakna (dimensi), dan secara opsional membatasi data yang dihasilkan berdasarkan karakteristik data yang spesifik (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 menurut proxy API:
Kolom - Setiap proxy API direpresentasikan oleh kolom yang berbeda:
Baris - Setiap proxy API direpresentasikan sebagai baris yang berbeda:
Untuk informasi selengkapnya, lihat Membuat dan mengelola laporan kustom.
Analytics API
Gunakan Apigee API untuk mendownload data analisis. Misalnya, Anda bisa menggunakan API untuk membangun alat visualisasi Anda sendiri yang dapat disematkan di portal atau aplikasi khusus.
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 akan menampilkan:
- Jumlah permintaan (jumlah pesan) per proxy API
- Untuk 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 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 selama sehari penuh dari Apigee ke repositori data Anda sendiri, seperti Google Cloud Storage atau BigQuery. Anda kemudian dapat memanfaatkan kemampuan kueri dan {i>machine learning<i} yang canggih yang ditawarkan oleh Google Cloud BigQuery dan TensorFlow untuk melakukan analisis data Anda sendiri.
Untuk mengetahui informasi selengkapnya, lihat Mengekspor data dari Analytics.
Bagaimana cara berbagi data dengan developer aplikasi?
Ketika Anda menganggap developer aplikasi sebagai pelanggan, Anda harus memastikan mereka memiliki alat tersebut dan informasi yang tersedia bagi mereka agar dapat memanfaatkan sebaik-baiknya API Anda.
Developer aplikasi tidak hanya mementingkan kualitas aplikasi, mereka juga sangat tertarik dengan API Anda. Portal developer berbasis Drupal menyertakan halaman Performa Aplikasi opsional yang didesain 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-nya lambat? Metode API mana yang biasanya lambat atau lambat?
- Ketersediaan: Apakah API sedang naik atau turun?
- Kuota: Apakah API Anda memiliki kuota? Dan sebagai developer aplikasi, bagaimana performa saya melebihi kuota?
Untuk 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 luas untuk dibagikan kepada developer aplikasi secara offline. Untuk informasi selengkapnya, lihat Menggunakan API metrik.
Bagaimana cara membuat data analisis yang lengkap?
Apa yang dimaksud dengan analisis lengkap? Misalnya, Anda dapat membuat proxy API dan Apigee akan mengumpulkan data analitik tentang {i>proxy<i} itu. Namun, bagaimana dengan metrik untuk pengembang atau aplikasi yang disebut proxy API? Jika Apigee tidak mengetahui siapa yang melakukan panggilan API, Apigee tidak dapat mengumpulkan data tersebut.
Beberapa langkah diperlukan agar Apigee dapat mengetahui developer dan aplikasi developer mana yang memanggil proxy API Anda. Berikut daftar langkah-langkah tersebut beserta link ke informasi lebih mendetail:
- Buat satu atau beberapa produk API, yang merupakan pengelompokan proxy API beserta paket layanan tertentu. 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 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.