@sweet5/monitor
v1.0.8
Published
前端监控埋点工具
Downloads
5
Maintainers
Readme
小程序端监控埋点工具
| 参数 | 说明 | 类型 | 必填 | 默认值 |
| ----------------------- | -------------------------------------------------------- | ----------------------------------------------------------- | ---- | ------- |
| requestUrl | 上报接口地址 | string
| 是 | - |
| appKey | app 唯一标识 | string
| - | - |
| appTrack | 是否上报 App 生命周期 | boolean
| - | true
|
| pageTrack | 是否上报 Page 生命周期 | boolean
| - | true
|
| consoleTrack | 是否上报控制台打印 | boolean
| - | false
|
| requestTrack | 是否上报请求 | boolean
| - | true
|
| routeTrack | 是否上报路由跳转 | boolean
| - | true
|
| tapTrack | 是否上报用户点击 | boolean
| - | true
|
| sendSize | 一次上报数据最大长度 | number
| - | 20
|
| sendTimeInterval | 自动上报时间间隔 | number
| - | 10
|
| debug | 是否在控制台输出 log 信息 (consoleTrack
为true
时无效) | boolean
| - | - |
| filterRequestUrls | 不需要上报的请求 | Array<string \| RegExp>
| - | - |
| gzip | 是否使用 gzip 对上报数据进行压缩 | boolean
| - | - |
| adaptSweet7flink | 是否将上报数据转换成适配 flink 的数据格式 | boolean
| - | - |
| beforeAddToBehaviorList | 用户行为数据添加到行为栈之前的钩子函数 | (behavior: IBehavior) => { [key: string]: any }
| - | - |
| beforeSend | 发送数据之前对数据进行加工的钩子函数 | (transportData: ITransportData) => { [key: string]: any }
| - | - |
| extraData | 用户自定义上报数据 | () => { [key: string]: any }
| - | - |
web 端监控埋点工具
| 参数 | 说明 | 类型 | 必填 | 默认值 |
| ----------------------- | -------------------------------------------------------- | ----------------------------------------------------------- | ---- | ------- |
| requestUrl | 上报接口地址 | string
| 是 | - |
| appKey | app 唯一标识 | string
| - | - |
| appTrack | 是否上报 App 生命周期 | boolean
| - | true
|
| pageTrack | 是否上报 Page 生命周期 | boolean
| - | true
|
| consoleTrack | 是否上报控制台打印 | boolean
| - | false
|
| requestTrack | 是否上报请求 | boolean
| - | true
|
| routeTrack | 是否上报路由跳转 | boolean
| - | true
|
| tapTrack | 是否上报用户点击 | boolean
| - | true
|
| sendSize | 一次上报数据最大长度 | number
| - | 20
|
| debug | 是否在控制台输出 log 信息 (consoleTrack
为true
时无效) | boolean
| - | - |
| filterRequestUrls | 不需要上报的请求 | Array<string \| RegExp>
| - | - |
| gzip | 是否使用 gzip 对上报数据进行压缩 | boolean
| - | - |
| adaptSweet7flink | 是否将上报数据转换成适配 flink 的数据格式 | boolean
| - | - |
| beforeAddToBehaviorList | 用户行为数据添加到行为栈之前的钩子函数 | (behavior: IBehavior) => { [key: string]: any }
| - | - |
| beforeSend | 发送数据之前对数据进行加工的钩子函数 | (transportData: ITransportData) => { [key: string]: any }
| - | - |
| extraData | 用户自定义上报数据 | () => { [key: string]: any }
| - | - |