Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Laporan kustom memungkinkan Anda untuk melihat perincian metrik API tertentu dan melihat data persis yang ingin Anda lihat. Dari dasbor API Monitoring, Anda dapat membuat laporan kustom dengan preset filter dan metrik berdasarkan kondisi yang dikonfigurasi pada saat pembuatan. Selain itu, kumpulan dimensi dan metrik default dikonfigurasi dalam laporan untuk Anda.
Buat laporan kustom berdasarkan konteks Anda
Buat laporan kustom dengan cepat berdasarkan konteks Anda seperti yang diringkas dalam tabel berikut. Di halaman Laporan Kustom, laporan kustom yang dibuat menggunakan Pemantauan API diberi nama secara unik (secara default), seperti yang ditunjukkan dalam tabel; Anda dapat mengubah namanya saat mengedit laporan kustom.
| Konteks laporan kustom | Konvensi penamaan default untuk laporan kustom |
|---|---|
| Dasbor terbaru | API Monitoring Recent Generated |
| Dasbor linimasa | API Monitoring Timeline Generated |
| Investigasi dasbor | API Monitoring Investigate Generated |
| Kondisi pemberitahuan | API Monitoring Generated: alert-name |
Dimensi dan metrik default
Secara default, laporan kustom akan menyertakan dimensi dan metrik yang tercantum dalam tabel berikut untuk semua laporan yang dihasilkan Pemantauan API.
| Komponen | Default |
|---|---|
| Dimensi | URI Permintaan |
| Metrik |
|
Mengedit laporan kustom
Seperti yang disebutkan di bagian sebelumnya, kumpulan dimensi dan metrik default yang ditentukan sebelumnya dari API Monitoring telah dikonfigurasi sebelumnya dalam laporan kustom. Setelah dibuat, Anda dapat mengedit laporan kustom tersebut untuk menambahkan atau menghapus metrik dan dimensi, sesuai kebutuhan. Misalnya, Anda mungkin ingin mempersempit penyelidikan ke token akses, aplikasi developer, proxy API, atau ID permintaan tertentu.
Dalam laporan kustom berikut, Anda menambahkan dimensi Gateway Flow ID yang telah ditentukan, dengan Gateway Flow ID berisi UUID unik dari setiap permintaan API yang dibuat ke Edge.
Perhatikan bahwa laporan sudah menggunakan dimensi Request URI:
Contoh berikut menambahkan dimensi Client ID ke laporan kustom.
Dimensi Client ID berisi kunci konsumen (kunci API) dari developer
yang melakukan panggilan API, baik yang diteruskan dalam permintaan sebagai kunci API maupun yang disertakan dalam token OAuth:
Laporan kustom berisi informasi untuk semua nilai Client ID.
Contoh berikutnya menambahkan filter sehingga Anda dapat membuat laporan kustom untuk Client ID tertentu:
Untuk informasi selengkapnya tentang semua dimensi dan metrik standar yang dapat Anda tambahkan ke laporan, lihat Referensi metrik, dimensi, dan filter Analytics.
Pada contoh berikutnya, Anda akan menambahkan Filter ke laporan kustom yang menangkap metrik dan dimensi default untuk kode kesalahan policies.ratelimit.QuotaViolation dan kode status 5xx:
Untuk detail selengkapnya tentang cara mengedit laporan kustom, lihat Mengelola laporan kustom.
Contoh: Menggunakan laporan kustom untuk mendiagnosis masalah deployment
Lampirkan kebijakan Statisticscollector ke proxy API Anda untuk mengumpulkan data analisis kustom, seperti ID pengguna atau produk, harga, tindakan REST, versi target, URL target, dan panjang pesan. Data dapat berasal dari variabel flow yang telah ditentukan oleh Apigee, header permintaan, parameter kueri, atau variabel kustom yang Anda tentukan.
Misalnya, permintaan ke proxy API Anda mencakup header untuk ID produk, ID pengguna, dan versi server target. Permintaan ini dapat berupa:
curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi
Anda kemudian dapat menggunakan informasi dalam header untuk membantu mendiagnosis masalah runtime dengan proxy API Anda.
Untuk membuat laporan kustom untuk header ini:
Tambahkan kebijakan Statisticscollector ke API Anda untuk mengambil nilai header kustom:
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic> <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic> <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic> </Statistics> </StatisticsCollector>
Deploy proxy Anda dan tunggu beberapa saat hingga dapat diakses.
Klik Analyze > API Monitoring > Recent di Edge UI untuk melihat masalah apa pun dengan API Anda. Perhatikan bahwa Anda mendapatkan error 4xx dan 5xx untuk proxy myapi:
Pilih baris proxy myapi untuk melihat detail selengkapnya di panel kanan dasbor Terbaru.
Di panel kanan dasbor Recent, pilih
> View in Menyelidiki untuk mengakses dasbor Investigasi:
Filter dasbor Investigasi berdasarkan proxy myapi, lalu lihat Kode Status di diagram teratas. Perhatikan bahwa Anda mendapatkan error 403 dan 501:
Di UI Edge, pilih Analytics > Laporan Kustom > Laporan untuk membuat laporan kustom yang menyertakan nilai metrik kustom ini sebagai Dimensi.
Pilih + Laporan Kustom untuk membuat laporan kustom dengan nama myapi_errors.
Pilih Proxy Errors untuk Metrik, dan tetapkan Aggregate Function ke Sum. Anda dapat menambahkan lebih banyak metrik jika menginginkannya.
Pilih Dimensi Kode Status Respons standar, lalu tambahkan tiga statistik kustom prodid, targetersion, dan userid ke Dimensi:
Setel Filter agar hanya menyertakan data untuk proxy API myapi
(apiproxy eq 'myapi'):
Simpan laporan.
Jalankan laporan untuk 24 jam sebelumnya. Saat laporan pertama kali dibuka, Anda akan melihat diagram error HTTP 403 dan 501:
Di bagian Summary, klik 403 atau 510 untuk melihat produk yang menghasilkan error. Misalnya, pilih 403:
Klik ID produk pada Ringkasan untuk melihat error berdasarkan versi target (alfa atau beta):
Klik versi target di bagian Ringkasan untuk melihat error berdasarkan pengguna:
