apm-mini-sdk

支持平台

1. 百度小程序
2. 微信小程序
3. 钉钉小程序
4. 支付宝小程序

数据采集

1. 安装依赖包

npm install --save apm-mini-sdk

2. 引入依赖模块

// CJS
const miniAgent = require('apm-mini-sdk').default;
// ESM
import miniAgent from 'apm-mini-sdk';

3. 配置参数

const miniParam = {
  appId: '', // 必填  站点ID
  platform: 'baidu' // 必填 标识小程序平台，baidu:百度小程序，wx:微信小程序，ding_talk：钉钉小程序，alipay：支付宝小程序
  domain: '', // 选填  数据上报地址
  apiRepo: true, //选填 是否采集API请求
  thirdApi: true, // 选填 是否采集第三方API请求
  hashMode: true, // 选填 URL中#内容，在开启时做URL一部分处理，不开启时被当作锚点处理
  smartJsErr: true, // 选填 短时间内大批量JS错误智能消减，在一次访问中超过100条的相同JS错误就不进行上报
  JsErrClean: true, // 选填 监听和上报所有JS错误
  webResource: false, // 选填 是否采集静态资源（小程序固定为false，小程序中不采集静态资源）
  traceType:'apm', // 选填 参数值有：apm、otel,默认为apm表示应用监控APM调用链做前后端链路追踪，填入otel时将与可观测链路 OpenTelemetry 版产品做前后端链路追踪
};

4. 启动采集功能

agentAPM.startSDK(miniParam);

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 | 自定义参数名uid：String类型，最大长度为2048个字符。 | 是 | 无 |

7. 动态设置uid

agent.setTag(tag: String)

| 配置参数 | 说明 | 是否必填 | 默认值 |
| ---------- | ----------- | :-----------: | :-----------: | | tag | tag：String类型，最大长度为2048个字符。 | 是 | 无 |

8. 自定义上报加载性能数据

agent.addPerformanceData(data: PerformanceData)

PerformanceData参数说明 | 配置参数 | 说明 | 是否必填 | 默认值 |
| ---------- | ----------- | :-----------: | :-----------: | | loadTime | 加载时间，数值型 | 否 | 0 |
| fcp | 首屏时间，数值型 | 否 | 0 |
| fp | 白屏时间，数值型 | 否 | 0 | | domtti | 可交互时间，数值型 | 否 | 0 | | cls | 累计布局偏移，数值型 | 否 | 0 | | inp | 绘制交互，数值型 | 否 | 0 | | lcp | 最大内容绘制，数值型 | 否 | 0 | 注：在PerformanceData中有值，且数值相加大于0时上报数据。

9. 自定义上报错误数据

agent.addErrorData(data: ErrorData)

ErrorData参数说明 | 配置参数 | 说明 | 是否必填 | 默认值 |
| ---------- | ----------- | :-----------: | :-----------: | | type | 错误类型，字符型 | 是 | 无 |
| message | 错误信息，字符型 | 是 | 无 |
| stack | 错误堆栈，字符型 | 否 | 无 |

版本更新说明

2.0.5

1.新增setUid和setTag方法，用户可自定义上报uid和tag标识。

2.0.4

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

2.0.1

1.添加README帮助文档

2.0.0

1.小程序探针上线