Topik ini menjelaskan cara menggunakan fitur pemantauan browser dari Application Real-Time Monitoring Service (ARMS) untuk memantau program mini WeChat. Topik ini juga mencakup konfigurasi SDK umum, Operasi API, dan skenario lanjutan dari fitur pemantauan browser.
Informasi latar belakang
Untuk informasi lebih lanjut tentang program mini WeChat, kunjungi program mini WeChat.
Metode dasar
Untuk memantau program mini WeChat, Anda perlu melakukan langkah-langkah berikut:
Mendapatkan dan menginisialisasi SDK pemantauan untuk program mini WeChat.
Buat file wxLogger.js di folder /utils pada program mini WeChat yang ingin dipantau, lalu salin isi dari file JS ke file wxLogger.js.
Buat file monitor.js di folder /utils, lalu tambahkan konten berikut ke file monitor.js untuk menginisialisasi SDK pemantauan.
CatatanAnda dapat menyesuaikan nama dan jalur penyimpanan file JS sesuai kebutuhan.
Jika proyek diintegrasikan menggunakan metode node module (require), tambahkan konten berikut ke file monitor.js:
const WXLogger = require('./wxLogger.js'); const Monitor = WXLogger.init({ pid: 'xxx', region: 'cn', // Tentukan wilayah tempat aplikasi diterapkan. Nilai cn menunjukkan Tiongkok, dan nilai sg menunjukkan wilayah dekat Singapura. }); export default Monitor;Jika proyek diintegrasikan menggunakan metode ES module (import), tambahkan konten berikut ke file monitor.js:
import WXLogger from './wxLogger.js'; const Monitor = WXLogger.init({ pid: 'xxx', region: 'cn', // Tentukan wilayah tempat aplikasi diterapkan. Nilai cn menunjukkan Tiongkok, dan nilai sg menunjukkan wilayah dekat Singapura. }); export default Monitor;
CatatanUntuk informasi lebih lanjut tentang pengaturan parameter, lihat Parameter SDK Umum.
Gunakan metode berikut untuk secara otomatis mengumpulkan PV, kesalahan, API, kinerja, dan data kesehatan program mini WeChat:
Di app.js, panggil metode Monitor.hookApp(options) untuk menangkap log kesalahan secara otomatis. Parameter options merupakan objek yang spesifik untuk aplikasi tersebut.
import Monitor from '/util/monitor'; App(Monitor.hookApp({ onError(err) { console.log('Trigger onError:', err); }, onLaunch() { console.log('Trigger onLaunch'); }, onShow(options) { }, onHide() { } }));Di page.js, panggil metode Monitor.hookPage(options) untuk secara otomatis melaporkan API, PV, dan data kesehatan program mini WeChat.
import Monitor from '/util/monitor'; // Setelah Anda memanggil metode hookPage, instrumen berbasis siklus hidup API secara otomatis dimulai. Page(Monitor.hookPage({ data: {}, onLoad(query) { }, onReady() { // Halaman dimuat. }, onShow() { }, onLoad(query) { }, onHide() { }, onUnload() { } }));
Tetapkan nama domain aman.
Jika parameter region disetel ke
cn, tambahkanhttps://arms-retcode.aliyuncs.comke daftar nama domain valid permintaan.Jika parameter region disetel ke
sg, tambahkanhttps://arms-retcode-sg.aliyuncs.comke daftar nama domain valid permintaan.
Metode dasar untuk instrumentasi otomatis
Metode | Parameter | Deskripsi | Skenario |
hookApp | null | Masukkan parameter sumber aplikasi. | Lakukan instrumentasi otomatis selama siklus hidup aplikasi. |
hookPage | null | Masukkan parameter sumber halaman. | Pengelolaan siklus hidup API secara otomatis melacak halaman. |
Jika Anda ingin memanggil metode hookApp atau hookPage untuk melacak dan memantau program mini, kode tersebut harus sesuai dengan spesifikasi aplikasi dan halaman program mini standar. Metode onError harus disertakan dalam kode aplikasi. Metode onShow, onHide, dan onUnload harus disertakan dalam kode halaman. Untuk informasi lebih lanjut, lihat Metode Dasar.
Metode untuk pengaturan lainnya
Metode | Parameter | Deskripsi |
setCommonInfo | {[key: string]: string;} | Tetapkan field log dasar untuk skenario seperti rilis canary. |
setConfig | {[key: string]: string;} | Tetapkan field config. Untuk informasi lebih lanjut, lihat Referensi SDK. Catatan Untuk metode setConfig, parameter uid tidak didukung jika Anda memantau program mini. Namun, Anda dapat menggunakan parameter setUsername untuk menggantikan parameter uid. |
pageShow | null | Laporkan log PV. |
pageHide | null | Laporkan log kesehatan. |
error | String/Object | Laporkan log kesalahan. |
api | Untuk informasi lebih lanjut, lihat Metode SDK. | Laporkan log permintaan API. |
sum/avg | String | Laporkan log jumlah dan rata-rata kustom. |
Skema lanjutan
Jika penggunaan dasar pemantauan aplikasi tidak dapat memenuhi kebutuhan Anda, coba gunakan skenario lanjutan berikut:
Laporkan hasil permintaan API secara manual.
Tetapkan parameter disableHook ke
true. Log permintaan wx.request tidak dilaporkan secara otomatis.Panggil metode api() secara manual untuk melaporkan hasil permintaan API.
Nonaktifkan pelaporan otomatis dan aktifkan pelacakan manual.
Jangan gunakan metode hookApp dan hookPage di file app.js dan page.js.
Untuk mengirim data PV halaman saat ini, panggil metode pageShow() di metode onShow Page.
CatatanKami sarankan Anda tidak memanggil metode pageShow() bersamaan dengan metode hookPage(). Jika tidak, log PV akan dilaporkan berulang kali.
import Monitor from '/util/monitor'; Page({ onShow: function() { Monitor.pageShow(); } })Untuk mengirim data kesehatan termasuk kesehatan dan waktu penelusuran halaman saat ini, panggil metode pageHide() di bawah metode onHide dan onUnload Page.
CatatanJangan panggil metode pageHide() bersamaan dengan metode hookPage(). Jika tidak, log akan dilaporkan berulang kali.
import Monitor from '/util/monitor'; Page({ onHide: function() { Monitor.pageHide(); }, onUnload: function() { Monitor.pageHide(); } ... })
Parameter SDK Umum
Fitur pemantauan browser ARMS memungkinkan Anda menetapkan berbagai parameter SDK untuk memenuhi persyaratan tambahan. Tabel berikut menjelaskan parameter umum yang cocok 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 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 kinerja dan log API sukses diambil sampelnya pada rasio | Tidak |
|
behavior | Boolean | Menentukan apakah akan mencatat perilaku pengguna yang melaporkan kesalahan untuk memudahkan pemecahan masalah. | Tidak |
|
enableLinkTrace | Boolean | Untuk informasi lebih lanjut tentang Analisis Tracing depan-belakang, lihat Gunakan fitur tracing depan-belakang untuk mendiagnosis kesalahan API. | Tidak |
|
Fitur pemantauan browser ARMS juga menyediakan parameter SDK lainnya untuk memenuhi kebutuhan bisnis Anda. Untuk informasi lebih lanjut, lihat Referensi SDK.