aegis-mp-rum-wrapper
v0.1.12
Published
基于 aegis-mp-sdk 的小程序上报封装 SDK,支持双实例与自定义 RUM 日志构造。
Downloads
1,396
Readme
aegis-mp-rum-wrapper
基于 aegis-mp-sdk 的小程序上报封装 SDK,用于在小程序中上报 RUM 日志,并在原有 Aegis 能力上增加一层业务侧埋点封装。
安装
npm install aegis-mp-rum-wrapper aegis-mp-sdk --save在小程序开发者工具中执行「构建 npm」,确保依赖可用。
快速使用
1. 在小程序入口初始化用户信息
import { AegisW } from 'aegis-mp-rum-wrapper';
// 初始化用户信息(示例)
AegisW.user = {
openid: 'xxxx',
roleID: 'xxxx',
area: 1,
zone: 1,
channeldID: 100, // 可选,SDK 会自动映射到 channelID
plat: 9,
serviceType: 'xxx', // 必填
eventID: 'page_enter', // 必填
contentID: 'doc_001',
locale: 'zh',
accountType: 'wx',
channelUID: '600',
columnUID: '60055',
platName: 'PC',
ext1: '',
ext2: '',
ext3: '',
};当 openid、serviceType、eventID 三个字段均非空时,会自动初始化默认 Aegis 实例并开始上报。
2. 自定义事件上报
// 与 aegis-mp-sdk 保持一致,自定义事件填写 name 和 extX 字段
AegisW.reportEvent({
name: 'vote',
ext1: '22',
ext2: '22',
ext3: '22',
});内部会自动把扩展业务日志打包成 JSON 串写入 ext1,并通过 Aegis 实例上报。
高级用法
如果需要更细粒度控制,可以使用函数式 API:
import {
configureWrapper,
setUser,
setRumID,
reportEvent,
getInstances,
} from 'aegis-mp-rum-wrapper';configureWrapper:配置上报基础行为(如是否测速、延迟等)setUser:更新用户信息,并在条件满足时初始化默认实例setRumID:设置服务侧 RUM ID 并初始化服务实例reportEvent:事件上报(与AegisW.reportEvent等价)getInstances:获取底层defaultAegis/serviceAegis实例
许可证
MIT
