wby-tracker v1.0.4

简介

wby-tracker是一个前端js埋点SDK,用于数据采集-数据处理-数据分析和挖掘。

定义

js埋点是通过web页面中嵌入一段js脚本，监控用户在应用表现层的行为，使用户在访问页面时、自动触发js，收集用户访问行为日志，并提交到日志服务器。

统计指标

• PV（用户浏览量）=> MPA、SPA(history/hash)
• UV（独立访客数）=> 设置userId
• DOM（事件监听）=> 添加属性target-key
• error（js错误）
• promise（捕获错误）

install

npm install wby-tracker

usage

import Tracker from 'wby-tracker'

const tr = new Tracker({
    requestUrl:"xxxxxx", // 接口地址 必传
    loadTracker: true, // 多页面pv上报
    historyTracker: false, // history模式
    hashTracker: false, // hash模式
    domTracker: true, // dom操作
    jsError: true // error、promise错误捕获
})

// DOM上报 设置target-key 自动上报
<button target-key="埋点值">按钮</button>

// 添加用户id
tr.setUserId()

// 设置用户自定义参数
tr.setExtra()

// 自定义上报及参数
/**
 * @event 事件类型
 * @targetKey 事件标识
 * @data 上报数据 非必传
 */
tr.sendTracker({event:"事件类型",targetKey:"事件标识",data:{}})

options

/**
 * @userId 用户id uv标识
 * @requestUrl 接口上报地址
 * @loadTracker 多页面pv上报
 * @historyTracker history上报
 * @hashTracker hash上报
 * @domTracker 携带Tracker-key 事件上报
 * @sdkVersionsdk 版本
 * @extra 透传字段
 * @jsError js 和 promise 报错异常上报
 */
// 默认参数
export interface DefaultOptons {
  userId: string | undefined,
  requestUrl: string | undefined,
  loadTracker: boolean,
  historyTracker: boolean,
  hashTracker: boolean,
  domTracker: boolean,
  sdkVersion: string | number,
  extra: Record<string, any> | undefined,
  jsError:boolean
}