Tema ini menjelaskan cara menggunakan fitur pemantauan browser dari Application Real-Time Monitoring Service (ARMS) untuk memantau program mini Alipay. Ini juga mencakup konfigurasi SDK umum, operasi API, serta skenario lanjutan dari fitur pemantauan browser.
Penggunaan dasar
Perkenalkan dan inisialisasi paket npm.
Dalam proyek program mini Anda, perkenalkan paket npm bernama
@arms/js-sdkuntuk memudahkan pelaporan log.npm install @arms/js-sdkTambahkan informasi berikut ke file monitor.js di direktori /utils untuk menginisialisasi paket.
CatatanAnda dapat menentukan nama dan jalur penyimpanan file JavaScript (JS).
import AlipayLogger from '@arms/js-sdk/miniapp'; const Monitor = AlipayLogger.init({ pid: 'xxx', region: 'cn', // Wilayah tempat aplikasi diterapkan. Set region ke cn jika aplikasi diterapkan di Tiongkok dan set region ke sg jika aplikasi diterapkan di luar Tiongkok. }); export default Monitor;CatatanUntuk informasi lebih lanjut tentang pengaturan parameter, lihat Parameter Umum SDK.
Atur nama domain aman.
Jika region disetel ke
cn, tambahkan arms-retcode.aliyuncs.com ke domain aman HTTP.Jika region disetel ke
sg, tambahkan arms-retcode-sg.aliyuncs.com ke domain aman HTTP.
Metode API lainnya
Metode | Parameter | Deskripsi |
setCommonInfo | {[key: string]: string;} | Set field log dasar untuk skenario seperti rilis bertahap. |
setConfig | {[key: string]: string;} | Set bidang config. Untuk informasi lebih lanjut, lihat Referensi SDK. |
pageShow | {} | Instrumen data PV. |
pageHide | {} | Instrumen data kesehatan. |
error | String/Object | Instrumen log kesalahan. |
api | Untuk informasi lebih lanjut, lihat Metode SDK. | Laporkan log API. |
sum/avg | String | Laporkan log jumlah dan rata-rata kustom. |
Skenario lanjutan
Jika penggunaan dasar tidak dapat memenuhi kebutuhan Anda, lihat skenario lanjutan berikut:
Laporkan hasil permintaan API secara manual.
Setel disableHook ke
true. Log dari my.httpRequest tidak dilaporkan secara otomatis.Panggil metode api() secara manual untuk melaporkan operasi API.
Nonaktifkan pelaporan otomatis dan aktifkan instrumentasi manual.
Jangan gunakan metode hookApp dan hookPage di file app.js dan page.js.
Untuk mengirim data PV halaman, panggil metode pageShow() di dalam metode onShow.
CatatanKami sarankan agar Anda tidak memanggil metode pageShow() bersama dengan metode hookPage(). Jika tidak, log PV dilaporkan berulang kali.
import Monitor from '/util/monitor'; Page({ onShow: function() { Monitor.pageShow(); } })Untuk mengirim data kesehatan (kesehatan dan waktu penjelajahan) halaman, panggil metode pageHide() di metode onHide dan onUnload.
CatatanKami sarankan agar Anda tidak memanggil metode pageHide() bersama dengan metode hookPage(). Jika tidak, log dilaporkan berulang kali.
import Monitor from '/util/monitor'; Page({ onHide: function() { Monitor.pageHide(); }, onUnload: function() { Monitor.pageHide(); } ... })
Parameter umum SDK
Pemantauan browser ARMS menyediakan serangkaian parameter SDK. Anda dapat mengonfigurasi parameter tersebut untuk memenuhi persyaratan tambahan. Tabel berikut menjelaskan parameter umum yang sesuai untuk skenario yang dijelaskan dalam topik ini.
|
|
|
|
|
pid | String | ID unik proyek. Ini dibuat secara otomatis oleh ARMS saat membuat situs. | Ya | Tidak ada |
uid | String | ID pengguna. Nilainya adalah pengenal pengguna dan dapat digunakan untuk mencari pengguna. Anda dapat menentukan nilai kustom. Jika Anda tidak menentukan parameter ini, SDK akan dibuat dan diperbarui setiap enam bulan secara otomatis. | Tidak | Dibuat secara otomatis oleh SDK |
tag | String | Tag input. Setiap log membawa tag. | Tidak | Tidak ada |
release | String | Versi aplikasi. Kami sarankan Anda mengonfigurasi parameter ini untuk melihat informasi laporan dari versi yang berbeda. | Tidak |
|
environment | String | Bidang lingkungan. Nilai yang valid: prod, gray, pre, daily, dan local.
| Tidak |
|
sample | Integer | Konfigurasi sampling log. Nilainya adalah bilangan bulat dari 1 hingga 100. Log performa dan log API sukses diambil sampelnya pada rasio | Tidak |
|
behavior | Boolean | Menentukan apakah akan mencatat perilaku pengguna yang melaporkan kesalahan untuk mempermudah pemecahan masalah. | Tidak |
|
enableLinkTrace | Boolean | Untuk informasi lebih lanjut tentang Analisis Tracing ujung-ke-ujung, lihat Gunakan fitur tracing ujung-ke-ujung untuk mendiagnosis kesalahan API. | Tidak |
|
Pemantauan browser ARMS juga menyediakan parameter SDK lainnya. Untuk informasi lebih lanjut, lihat Referensi SDK.