Application Real-Time Monitoring Service:Memantau mini program WeChat

Informasi latar belakang

Untuk informasi latar belakang mengenai mini program WeChat, lihat dokumentasi mini program WeChat.

Penggunaan dasar

Untuk memantau mini program WeChat dengan ARMS Browser Monitoring, lakukan tiga langkah berikut:

1. Dapatkan SDK pemantauan mini program WeChat dan inisialisasi SDK tersebut:

   1. Di direktori /utils proyek mini program WeChat Anda, buat file bernama wxLogger.js. Salin isi dari file JS SDK pemantauan dan tempelkan ke dalam file wxLogger.js.
   2. Di direktori /utils, buat file bernama monitor.js dan tambahkan kode berikut ke dalam file monitor.js untuk menginisialisasi SDK.
      Catatan Anda dapat menyesuaikan nama file dan lokasi penyimpanannya.

      • Jika proyek Anda menggunakan modul Node.js (require), tambahkan kode berikut:

        const WXLogger = require('./wxLogger.js');
        const Monitor = WXLogger.init({
          pid: 'xxx',
          region: 'cn', // Tentukan wilayah penerapan: atur ke cn untuk Tiongkok, atau sg untuk wilayah di dekat Singapura.
        });
        export default Monitor;

      • Jika proyek Anda menggunakan modul ES (import), tambahkan kode berikut:

        import WXLogger from './wxLogger.js';
        const Monitor = WXLogger.init({
          pid: 'xxx',
          region: 'cn', // Tentukan wilayah penerapan: atur ke cn untuk Tiongkok, atau sg untuk wilayah di dekat Singapura.
        });
        export default Monitor;

      Atur region ke wilayah penerapan aplikasi Anda: cn untuk Tiongkok, atau sg untuk wilayah di luar Tiongkok yang dekat dengan Singapura.

      Catatan Untuk konfigurasi parameter detail, lihat Parameter SDK.

2. Aktifkan instrumentasi otomatis untuk mengumpulkan data PV, error, API, performa, dan kesehatan:

   1. Di app.js, gunakan metode Monitor.hookApp(options) untuk secara otomatis menangkap log error. Parameter options merupakan objek konfigurasi pada layer App.

      import Monitor from '/utils/monitor';
      
      App(Monitor.hookApp({
        onError(err) {
          console.log('Enter onError:', err);
        },
        onLaunch() {
          console.log('Enter onLaunch');
        },
        onShow(options) {
        },
        onHide() {
        }
      }));

   2. Pada file JS setiap halaman, gunakan metode Monitor.hookPage(options) untuk melaporkan permintaan API, PV, dan data kesehatan secara otomatis.

      import Monitor from '/utils/monitor';
      
      // Setelah Anda menggunakan hookPage, API siklus hidup akan diinstrumentasi secara otomatis.
      Page(Monitor.hookPage({
        data: {},
        onLoad(query) {
        },
        onReady() {
          // Halaman dimuat.
        },
        onShow() {
        },
        onHide() {
        },
        onUnload() {
        }
      }));

3. Konfigurasi domain keamanan: tambahkan domain ARMS yang sesuai dengan nilai region Anda ke daftar domain permintaan valid mini program WeChat.

   • Jika region diatur ke cn, tambahkan https://arms-retcode.aliyuncs.com ke daftar domain permintaan yang valid.

   • Jika region diatur ke sg, tambahkan https://arms-retcode-sg.aliyuncs.com ke daftar domain permintaan yang valid.

Parameter SDK

ARMS Browser Monitoring menyediakan parameter konfigurasi SDK yang dapat Anda atur untuk memenuhi kebutuhan tambahan. Tabel berikut menjelaskan parameter konfigurasi umum yang berlaku untuk mini program WeChat.

ARMS Browser Monitoring juga menyediakan parameter konfigurasi SDK tambahan untuk kebutuhan lebih lanjut. Untuk informasi selengkapnya, lihat Parameter konfigurasi SDK.

API instrumentasi otomatis

Tabel berikut menjelaskan metode yang disediakan SDK pemantauan mini program WeChat untuk instrumentasi siklus hidup otomatis.

API konfigurasi lainnya

Tabel berikut menjelaskan metode yang dapat Anda panggil untuk mengonfigurasi SDK pemantauan mini program WeChat dan melaporkan data.

Kasus penggunaan lanjutan

Jika metode instrumentasi otomatis yang dijelaskan dalam Penggunaan dasar tidak memenuhi kebutuhan Anda, gunakan salah satu konfigurasi lanjutan berikut:

• Laporkan informasi API secara manual alih-alih menggunakan instrumentasi otomatis:

  1. Atur disableHook ke true untuk menonaktifkan pelaporan log otomatis pada permintaan wx.request.

  2. Panggil metode api() secara manual untuk melaporkan informasi API.

• Nonaktifkan instrumentasi otomatis dan instrumentasi halaman Anda secara manual:

  1. Jangan gunakan metode hookApp atau hookPage di file JS App dan Page.

  2. Untuk mengirim data PV halaman saat ini, panggil metode pageShow() dalam metode onShow halaman.

     Catatan Jangan gunakan metode ini bersamaan dengan hookPage(), karena akan menyebabkan pelaporan data PV ganda.

     import Monitor from '/utils/monitor';
     
     Page({
       onShow: function() {
         Monitor.pageShow();
       }
     })

  3. Untuk mengirim data kesehatan halaman saat ini—termasuk metrik kesehatan halaman dan durasi kunjungan—panggil metode pageHide() dalam metode onHide dan onUnload halaman.

     Catatan hookPage()Jangan gunakan metode ini bersamaan dengan . Jika tidak, data kesehatan duplikat akan dilaporkan.

     import Monitor from '/utils/monitor';
     
     Page({
       onHide: function() {
         Monitor.pageHide();
       },
       onUnload: function() {
         Monitor.pageHide();
       }
       // Metode siklus hidup lainnya.
     })