1.4.2 • Published 1 year ago
@monsterooo/tracker v1.4.2
title: Http 数据请求 sidemenu: false nav: title: 埋点 path: /tracker
order: 4
Tracker 埋点
前端日志文档
使用方式
yarn add @monsterooo/tracker常规使用
自动上报埋点
自动埋点功能，通过监听全局 event，当产生 click 事件的节点具有 data-track 属性的时候会自动对该事件进行上报；
使用方式
- 初始化 tracker 时， autoTrack 设置为 true；
- 在发生点击事件的的元素上设置 data-track 属性；
demo 如下
小程序接入
目前已经内置小程序（微信小程序，飞书小程序）的埋点上报，只是暂时不支持自动埋点上报共功能，其他使用方法一样的；
接口
Tracker options
| key | 说明 | 类型 | 默认值 |
|---|---|---|---|
| client | 项目 id，比如 web, h5, | string | 必填 |
| env | 上报环境 | qa,dev,prod | 必填 |
| uid | 用户唯一标示 | string | 非必填 |
| pageName | 页面名称 | string | 非必填 |
| autoTrack | 是否自动上报, 目前暂时只支持浏览器 | boolean | false |
如果 options 中还有其他参数，则这些参数会默认放在请求的content字段中
Tracker instance
| 方法 | 说明 | 类型 |
|---|---|---|
| sendPV | 上报 PV | (data: any) => any |
| sendEvent | 上报事件 | (eventId: string, data?: any) => any |
| sendLogData | 上报日志。_level_ 日志级别，枚举值（Verbose、Debug、Info、Warn、Error），必填。_msg_ 日志内容，必填。_tag_ 日志标签，必填。更多信息参考文档，log 类型 | (data: { level, msg, tag }) => any |
| setCommonData | 设置 commonData，放置在请求中的common字段, 对应在日志中_common_字段 | (data: Record<string, any>) => void |
| setParams | 设置 params, 放置在请求content中的字段,对应在日志中_content_字段 | (data: Record<string, any>) => void |
Tracker Defaults 配置
| 方法 | 说明 | 类型 |
|---|---|---|
| apis | 日志上报接口 | { qa: string, dev: string, prod: string } |
| request | 请求发送方式 | (params:{url: string, data: any, method: string, header}) => Promise |
| getCommonData | 设置获取默认 CommonData | () => Record<string, any> |
FAQ
- defaults 中 request 中的 header 字段必须要包含在请求头中，阿里云那边需要；
1.4.2
1 year ago