@shuyun-ep-team/monitor-track

数云前端监控及埋点SDK工具javascript版本

Usage no npm install needed!

<script type="module">
  import shuyunEpTeamMonitorTrack from 'https://cdn.skypack.dev/@shuyun-ep-team/monitor-track';
</script>

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,
  });
}