@shuyun-ep-team/monitor-track
v0.2.0
Published
数云前端监控及埋点SDK工具javascript版本
Downloads
11
Readme
数云前端监控及埋点 SDK 工具
使用
# Using npm
$ npm install @shuyun-ep-team/monitor-track -S
import Track from '@shuyun-ep-team/monitor-track';
const track = new Track();
track.init({
// 由监控平台后台管理系统创建项目时生成
projectID: '123',
// 同projectID
token: 'xxxxxx',
reportUrl: 'http://localhost:3008/report',
spa: true,
// 不是hash模式的项目一定要改成false,否则不能统计到pv的类型
hash: true,
});
配置项
| 配置项 | 类型 | 必填 | 默认值 | 注释 | | ----------------- | ------- | ---- | ------ | -------------------------------------------------- | | reportUrl | string | 是 | '' | 上报地址,后台地址 | | projectID | string | 是 | '' | 项目 ID | | token | string | 是 | '' | 项目所对应的标识识 | | delayReport | number | 否 | '' | 延迟上报 ,毫秒级 | | spa | boolean | 否 | false | 是否为单页面应用,主要区别页面性能,及路由切换行为 | | hash | boolean | 否 | false | 路由是否为 hash 模式 | | enablePerformance | boolean | 否 | false | 启用性能上报 | | enableBehavior | boolean | 否 | true | 启用用户行为上报 | | enableAjax | boolean | 否 | false | 启用 Ajax 上报 | | enableError | boolean | 否 | true | 启用异常信息上报 | | ignore | object | 否 | false | 忽略上报的信息 | | customPayload | string | 否 | false | 自定义 payload | | enable | boolean | 否 | false | 是否开启日志收集,默认关闭 | | maxLength | number | 否 | 1000 | 最长上报数据长度 |
ignore
| 参数 | 类型 | 必填 | 默认值 | 注释 | | ------ | -------- | ---- | ------ | -------------- | | urls | string[] | 否 | [] | 忽略的 url | | errors | string[] | 否 | [] | 忽略的异常信息 | | apis | string[] | 否 | [] | 忽略的接口 |
项目引入时,定义环境变量,防止开发环境中上报信息
// webpack中配置环境变量
new webpack.DefinePlugin({
isDev: 'development',
});
const isDevEnv = typeof isDev !== 'undefined';
if (isDevEnv) {
track.init({
// 由监控平台后台管理系统创建项目时生成
projectID: '123',
// 同projectID
token: 'xxxxxx',
reportUrl: 'http://localhost:3008/report',
spa: true,
// 不是hash模式的项目一定要改成false,否则不能统计到pv的类型
hash: true,
});
}