背景信息

關(guān)于微信小程序的背景信息，請(qǐng)參見微信小程序。

基礎(chǔ)使用方法

基礎(chǔ)方法包含獲取微信小程序監(jiān)控SDK并初始化、上報(bào)和設(shè)置安全域名這三個(gè)步驟：

1. 獲取微信小程序監(jiān)控SDK并初始化：

   1. 在微信小程序/utils目錄下新建wxLogger.js文件，并將JS文件的內(nèi)容復(fù)制并粘貼至新建的wxLogger.js文件中。
   2. 在/utils目錄下新建monitor.js文件，并將以下內(nèi)容添加至新建的monitor.js文件中以完成初始化。
      說明 您可以自定義JS文件的名稱和存放位置。

      • 如果項(xiàng)目使用node module (require) 方式集成，則添加以下內(nèi)容：

        const WXLogger = require('./wxLogger.js');
            const Monitor = WXLogger.init({
                pid: 'xxx',
                region: 'cn',    // 指定應(yīng)用部署的地域：中國設(shè)為cn，海外地區(qū)靠近新加坡的設(shè)為sg。
            });
            export default Monitor;

      • 如果項(xiàng)目使用ES module (import) 方式集成，則添加以下內(nèi)容：

        import WXLogger from './wxLogger.js';
            const Monitor = WXLogger.init({
                pid: 'xxx',
                region: 'cn',    // 指定應(yīng)用部署的地域：中國設(shè)為cn，海外地區(qū)靠近新加坡的設(shè)為sg。
            });
            export default Monitor;

      說明 關(guān)于參數(shù)的詳細(xì)配置，請(qǐng)參見通用SDK配置項(xiàng)。

2. 使用以下方法靜默采集PV、Error、API、性能及Health數(shù)據(jù)：

   1. 在app.js中，使用Monitor.hookApp(options)方法靜默捕獲Error類日志。其中的options即為App層相應(yīng)的Object配置。

      import Monitor from '/util/monitor';
      
      App(Monitor.hookApp({
        onError(err) {
            console.log('進(jìn)入onError:', err);
        },
        onLaunch() {
          console.log('進(jìn)入onLaunch');
        },
      
        onShow(options) {
        },
        onHide() {
        }
      }));

   2. 在page的JS文件中通過Monitor.hookPage(options)方法靜默上報(bào)API請(qǐng)求、PV、Health數(shù)據(jù)。

      import Monitor from '/util/monitor';
      // 使用hookPage后，生命周期的API會(huì)自動(dòng)打點(diǎn)。
      Page(Monitor.hookPage({
         data: {},
          onLoad(query) {
          },
          onReady() {
          // 頁面加載完成。
          },
          onShow() {
      
          },
          onLoad(query) {
      
          },
          onHide() {
      
          },
          onUnload() {
      
          }     
      }));

3. 設(shè)置安全域名：

   • 如果region設(shè)為cn，則將https://arms-retcode.aliyuncs.com添加到Request合法域名。

   • 如果region設(shè)為sg，則將https://arms-retcode-sg.aliyuncs.com添加到Request合法域名。

API方法：靜默打點(diǎn)基礎(chǔ)API

API方法：其他設(shè)置API

進(jìn)階場景

當(dāng)基礎(chǔ)使用方法無法滿足需求時(shí)，請(qǐng)參見以下進(jìn)階場景：

• 手動(dòng)上報(bào)API相關(guān)信息（不采用靜默上報(bào)方式）：

  1. 將disableHook設(shè)為true，不靜默上報(bào)wx.request請(qǐng)求的日志。

  2. 手動(dòng)調(diào)用api()方法上報(bào)API相關(guān)信息。

• 取消靜默上報(bào)并改為手動(dòng)打點(diǎn)：

  1. 在App和Page對(duì)應(yīng)的JS文件中不再使用hookApp、hookPage方法。

  2. 如需發(fā)送當(dāng)前頁面的PV數(shù)據(jù)，則在Page的onShow方法下調(diào)用pageShow()方法。

     說明 請(qǐng)勿與hookPage()方法同時(shí)使用此方法，否則會(huì)造成PV類日志重復(fù)上報(bào)。

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

  3. 如需發(fā)送當(dāng)前頁面的Health類數(shù)據(jù)，統(tǒng)計(jì)當(dāng)前頁面的健康度和頁面停留時(shí)間，則在Page的onHide和onUnload方法下調(diào)用pageHide()方法。

     說明 請(qǐng)勿與 hookPage()方法同時(shí)使用此方法，否則會(huì)造成日志重復(fù)上報(bào)。

     import Monitor from '/util/monitor';
       Page({
     
           onHide: function() {
               Monitor.pageHide();
           },
           onUnload: function() {
               Monitor.pageHide();
           }
           ... 
       })

通用SDK配置項(xiàng)

ARMS前端監(jiān)控提供一系列SDK配置項(xiàng)，讓您能夠通過設(shè)置參數(shù)來滿足額外需求。以下是適用于本文場景的通用配置項(xiàng)。

ARMS前端監(jiān)控還提供了更多SDK配置項(xiàng)，可滿足進(jìn)一步的需求。更多信息，請(qǐng)參見SDK參考。