开始监控支付宝小程序

背景信息

关于支付宝小程序的背景信息，请参见 支付宝小程序 。

基础使用方法

1. 引入 npm 包并初始化：

   1. 在支付宝小程序的项目中引入 @arms/js-sdk npm 包，以便使用该模块来上报日志。

      npm install @arms/js-sdk

   2. 将以下内容添加至 /utils 目录下的 monitor.js 文件中以完成初始化。

      说明

      您可以自定义 JS 文件的名称和存放位置。

      import AlipayLogger from '@arms/js-sdk/miniapp';
      const Monitor = AlipayLogger.init({
          pid: 'xxx',
          region: "cn", // 指定应用部署的地域：中国设为cn，中国以外地域设为sg。
      export default Monitor;              

      说明

      关于参数的详细配置，请参见 通用 SDK 配置项 。

2. 设置安全域名：

   • 如果 region 设为 cn ，则将 arms-retcode.aliyuncs.com 添加到 HTTP 安全域名。

   • 如果 region 设为 sg ，则将 arms-retcode-sg.aliyuncs.com 添加到 HTTP 安全域名。

API 方法：其他设置 API

进阶场景

当基础使用方法无法满足需求时，请参见以下进阶场景：

• 手动上报 API 相关信息（不采用静默上报方式）：

  1. 将 disableHook 设为 true ，不静默上报 my.httpRequest 请求的日志。

  2. 手动调用 api() 方法上报 API 相关信息。

• 取消静默上报并改为手动埋点：

  1. 在 App 和 Page 对应的 JS 文件中不再使用 hookApp、hookPage 方法。

  2. 如需发送当前页面的 PV 数据，则在 Page 的 onShow 方法下调用 pageShow() 方法。

     说明

     请勿与 hookPage() 方法同时使用此方法，否则会造成 PV 类日志重复上报。

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

  3. 如需发送当前页面的 Health 类数据，统计当前页面的健康度和页面停留时间，则在 Page 的 onHide 和 onUnload 方法下调用 pageHide() 方法。

     说明

     请勿与 hookPage() 方法同时使用 pageHide() ，否则会造成日志重复上报。

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

通用 SDK 配置项

ARMS 前端监控提供一系列 SDK 配置项，让您能够通过设置参数来满足额外需求。以下是适用于本文场景的通用配置项。

ARMS 前端监控还提供了更多 SDK 配置项，可满足进一步的需求。更多信息，请参见 SDK 参考 。