trace-sdk-for-fair-web

Quick introduce

功能

提供以下全局的采集类型

• 脚本错误
• 网络错误，ajax & fetch
• 点击事件
• url change
• performance 数据
• device 数据
• 自定义通过 createEvent 上传，待完善

使用

import { BrowserClient } from 'trace-sdk-for-fair-web'

export const traceInstance = BrowserClient.setup({
  appType: 'web',
  // 是否禁止click & url change的收集
  disableCaptureAction: true,
  // 是否禁用scripr error
  disableCaptureScript: false,
  // 是否禁用netwrok error
  disableCaptureNetwork: false
})

发包

npm run build

npm version patch

npm publish

目录结构

.
├── dist
│ ├── index.js // 打包文件
├── package-lock.json
├── package.json
├── readme.md
├── rollup.config.js // 打包配置文件
├── src
│ ├── action.js // action类
│ ├── browser // 浏览器内utils
│ │ ├── capture // 劫持浏览器原生方法，部分行为addAction
│ │ ├── dispatch // 事件分发，供capture调用，dispatch通过eventType类型调用不同的handler
│ │ ├── handle // createEvent & notify,事件上报
│ ├── config
│ │ ├── configSchema.js // setup config validate schema,not implement yet
│ │ ├── eventType.js // 事件类型分类
│ ├── data
│ │ ├── schema_ex1.jsonc // 前端上传json数据 demo data，未同步
│ │ └── table_ex1.jsonc // clickhouse table header data
│ ├── device.js // device数据
│ ├── event.js // event类，字段需要重新整理
│ ├── index.js // client类，以及初始化方法
│ ├── notify.js // 上传数据的实现sendBeacon & XMLHttpRequest
│ ├── peformance.js // performance数据和web-vitals数据
│ ├── table
│ │ └── trace.sql // click 表初始化sql语句，表头字段已改变
│ ├── utils
│ │ ├── cookie.js // cookie utils
│ │ ├── errorHandler.js // error handle utils
│ │ ├── get.js // get utils
│ │ ├── index.js // utils entry
│ │ ├── uuid.js // get traceid by uuid
│ │ ├── validator.js // validate utils
│ │ └── web-vitals // web-vitals package
│ └── verifyConfig.js // not implement yet