更新时间:2024-09-26 GMT+08:00
分享

支付宝小程序 SDK接入

使用前提

  • 使用应用性能监控服务Web SDK前,您需要注册华为账号并开通华为云。
  • 为确保小程序日志上报正常,需将上报地址添加到微信开发者平台域名列表,将上报域名添加为合法域名。

传输协议

HTTPS

版本更新说明

表1 版本更新说明

版本号

更新说明

2.0.5

新增uid和tag字段,与setUid和setTag方法。

2.0.4

修复SDK中覆盖了小程序原函数作用域的问题。

2.0.1

添加README帮助文档。

2.0.0

小程序探针上线。

前置条件

将APM上报地址“https://apm-web.cn-north-4.myhuaweicloud.com”添加到小程序开发者平台域名列表。

以微信小程序为例:

配置地址:https://mp.weixin.qq.com/wxamp/home/guide?lang=zh_CN;

配置位置:小程序后台->开发->开发设置->服务器域名,如有多个域名配置以分号分隔开。

操作步骤

  1. 进入前端监控页面,单击“接入前端站点”。

  2. 设置前端站点选择“支付宝小程序”,选择“所属应用”,填入“站点名称”,单击“创建前端站点”按钮。

  3. 安装SDK,在项目根目录下运行“npm i apm-mini-sdk”命令,拉取SDK软件包。

  4. 使能SDK,埋码代码会自动在小程序中完成埋点,所以建议在app.js中执行埋码代码,也可以在项目的任何位置执行。引入SDK方式分为:文件引入方式和npm方式引入。

    • 采用npm方式集成SDK。
      1. 运行安装SDK的命令,安装SDK软件包。
      2. 从页面复制用于埋码的代码放置到app.js文件中。

  5. 自定义上报统计 (可选步骤)。

    方法名称

    参数说明

    agent.log(key: String, value: String)

    key:事件名称, String类型,最大长度为2048个字符。

    value:事件内容,支持String,Array,HashMap, Number等有效的JSON对象,转JSON字符串最大长度为30720个字符。

  6. 动态设置uid(可选步骤)

    方法名称

    参数说明

    agent.setUid(uid: String)

    uid:String类型,最大长度为2048个字符。

  7. 动态设置tag(可选步骤)

    方法名称

    参数说明

    agent.setTag(tag: String)

    tag:String类型,最大长度为2048个字符。

数据上报策略

  1. 用户基础数据、自定义上报数据会在访问页面时立即上报。
  2. 页面性能数据会在页面加载完成后触发。
  3. 其他类型数据(API数据、JS错误数据等)会以一分钟的时间间隔上报数据。

相关文档