client-stat

旧版本文档

简介

前端埋点，支持：

• 页面上报
• 节点在窗口内上报
• 点击上报
• 已上报记录（参数可选）
• 上报数据以pipe形式进行操作（添加数据、修改上报格式等）
• 可以添加插件控制pipe
• 监听上报页面路径并可修改数据

安装依赖

npm install --save stat

初始化

import Stat from 'stat'
	
const stat = new Stat(params)

参数(params)

API（Stat构造函数）

API（stat实例）

插件类（plugins）

初始化（个别插件有先后顺序）

import Stat from 'stat'
import { VuePlugin, WatchRoutePlugin, NativePlugin, NativePlugin_3, H5_format } from 'stat/plugins'
// import Vue from 'vue'
// import hostSdk from 'host-sdk'
// import WatchRoute from 'watch-route'

const stat = new Stat({
	plugins: [
        // new VuePlugin(Vue),
        // new WatchRoutePlugin(WatchRoute),
		// new NativePlugin(hostSdk),
		// new NativePlugin_3(hostSdk), // 要求 host-sdk 3.x 版本及以上
        new H5_format(),
    ]
})

详情

• VuePlugin： 提供 v-stat 指令

  • 指令封装于 addNode 方法，参数一致

• WatchRoutePlugin： 提供 页面链（pageFrom）、父级信息（parentPage, parentParams）

  • 该插件需传入 WatchRoute 构造函数，并在stat实例上挂载route实例

• NativePlugin： 提供客户端埋点所需及上报，需和 WatchRoutePlugin 一同使用以获取页面链等上报所需数据

  • 该插件需传入 hostSdk 依赖

• H5_format： webapp上报格式化数据，转成上报需要的格式，

  • 该插件为stat实例提供 setClientDetail 方法，该方法用于设置：渠道（channel），平台（platform，该参数已内置判断），用户id（userId）

更新

4.3.0

插件中心库与vue解耦

4.2.1

节点上报行为与页面上报同步

4.2.0

更新 host-sdk plugin

兼容老 host-sdk

4.1.0

增加 API -> on 方法，可添加钩子

4.0.2

增加配置 closeAutoNodeReport ，可自动上报节点展示(nodeReport)

4.0.1

数据的完全可控

4.0.0

易用性、可扩展性重构