# 系统埋点插件封装设计（web端_小程序端）

**Repository Path**: muaiyuese/Event-Tracking

## Basic Information

- **Project Name**: 系统埋点插件封装设计（web端_小程序端）
- **Description**: 系统埋点插件封装设计（web端_小程序端）
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-12-04
- **Last Updated**: 2024-10-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目初始化启动方式

1/ 编译项目命令
yarn build
之后项目会生成一个 tracking-sdk 插件包。

2/ 将tracking-sdk插件包拷贝到所需要埋点的项目代码中。

3/ 实例化初始化插件，通过执行以下代码：

```
trackingSDK.init({
  appId: "",
  env: "",
  uid_channel: "",
  enableLoadEvent: true,
  enableHistoryEvent: true,
  ...
  其它配置信息
});
```
这样插件就初始化完成了。init为初始化方法，参数为配置信息options，具体配置信息如下。

## 插件具体配置信息

```
// 应用ID，必填
appId: '',
// 环境，选填
env: '',
// 用户渠道，选填
uid_channel: '',
// 用户信息，选填
uploadUserInfo: {},
// 启用验证，默认为false
enableVerify: false,
// 是否开启页面加载主动上报，适宜多页面应用上报，默认为true
enableLoadEvent: true,
// 是否开启页面history变动主动上报，适宜SPA单页面应用路由history模式上报，默认为false
enableHistoryEvent: false,
// 是否开启页面hash变动主动上报，适宜SPA单页面应用路由hash模式上报，默认为false
enableHashEvent: false,
// dom的点击事件主动上报的attr属性名称
eventTrackingKey: 't-key',
// dom的点击事件主动上报相关数据的attr属性名称
eventTrackingData: 't-data',
// 是否开启约定领有属性值为'eventTracking-key'的dom的点击事件主动上报
enableEventTrackingKey: true,
```

## 事件埋点
通过在项目任意DOM属性上，添加“t-key='自定义key'”即可，只要包含该属性的DOM元素被点击就会触发埋点上报请求。

## 业务埋点
在需要监控的业务功能流程后面，埋入以下代码，即可触发对应的业务埋点上报请求。

```
trackingSDK.trackEvent("custom-自定义业务ID", {
    foo: 1111,
    b: 222,
});
```

## 错误日志上报
在报错的接口逻辑后面，或者报错的语句后面，埋入以下代码即可。

```
trackingSDK.trackEvent("错误日志KEY", {
    trackType: "ERROR",
    data: {},
});
```