功能

• [√] ✈️ 错误捕获：代码报错、资源加载报错、接口请求报错
• [√] ✈️ 性能数据：FP、FCP、LCP、CLS、TTFB、FID
• [√] ✈️ 用户行为：页面点击、路由跳转、接口调用、资源加载
• [√] ✈️ 个性化指标：Long Task、Memory 页面内存、首屏加载时间
• [√] ✈️ 白屏检测：检测页面打开后是否一直白屏
• [√] ✈️ 错误去重：开启缓存队列，存储报错信息，重复的错误只上报一次
• [√] 🚀 手动上报错误
• [√] 🚀 支持多种配置：自定义 hook 与选项
• [√] 🚀 支持的 Web 框架：vue2、vue3、React

安装

$ npm i -S web-see

Vue

import webSee from 'web-see';

Vue.use(webSee, {
  dsn: 'http://text.com/reportData', // 上报的地址
  apikey: 'project1', // 项目唯一的id
  userId: '89757', // 用户id
  repeatCodeError: true, // 开启错误上报去重，重复的代码错误只上报一次
  silentRecordScreen: true, // 开启录屏
  silentWhiteScreen: true, // 开启白屏检测
  skeletonProject: true, // 项目是否有骨架屏
  whiteBoxElements: ['html', 'body', '#app', '#root'], // 白屏检测的容器列表
  handleHttpStatus(data) {
    // 自定义hook, 根据接口返回的 response 判断请求是否正确
    let { url, response } = data;
    // code为200，接口正常，反之亦然
    let { code } = typeof response === 'string' ? JSON.parse(response) : response;
    if (url.includes('/getErrorList')) {
      return code === 200 ? true : false;
    } else {
      return true;
    }
  },
});

React

import webSee from 'web-see';

webSee.init({
  dsn: 'http://localhost:8083/reportData',
  apikey: 'project1',
  userId: '89757',
});

常规配置项

| Name | Type | Default | Description | | :--------------------: | ---------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | dsn | string | "" | (必传项) 上报接口的地址，post 方法 | | apikey | string | "" | (必传项) 每个项目对应一个 apikey，唯一标识 | | userId | string | "" | 用户 id | | disabled | boolean | false | 默认是开启 SDK，为 true 时，会将 sdk 禁用 | | silentRecordScreen | boolean | false | 注意：默认不会开启录屏，为 true 时，开启录屏 | | silentWhiteScreen | boolean | false | 注意：默认不会开启白屏检测，为 true 时，开启检测 | | skeletonProject | boolean | false | 有骨架屏的项目建议设为 true，提高白屏检测准确性 | | whiteBoxElements | array | ['html', 'body', '#app', '#root'] | 白屏检测的容器列表，开启白屏检测后该设置才生效 | | filterXhrUrlRegExp | regExp | null | 默认为空，所有的接口请求都会被监听，不为空时，filterXhrUrlRegExp.test(xhr.url)为 true 时过滤指定的接口 | | useImgUpload | boolean | false | 为 true 时，使用图片打点上报的方式，参数通过 data=encodeURIComponent(reportData) 拼接到 url 上，默认为 false | | throttleDelayTime | number | 0 | 设置全局 click 点击事件的节流时间 | | overTime | number | 10 | 设置接口超时时长，默认 10s | | maxBreadcrumbs | number | 20 | 用户行为存放的最大容量，超过 20 条，最早的一条记录会被覆盖掉 | | recordScreentime | number | 10 | 单次录屏时长，silentRecordScreen 设为 true， 开启录屏后该设置才有效 | | recordScreenTypeList | array | ['error', 'unhandledrejection', 'resource', 'fetch', 'xhr'] | 上报录屏的错误列表，默认会上报所有错误发生时的录屏信息，如设置 ['error', 'unhandledrejection'] 则只会上报代码报错时的录屏 | | repeatCodeError | boolean | false | 是否开启去除重复的代码报错，开启的话重复的代码错误只上报一次 | | beforePushBreadcrumb | function | null | (自定义 hook) 添加到行为列表前的 hook，有值时，所有的用户行为都要经过该 hook 处理，若返回 false，该行为不会添加到列表中 | | beforeDataReport | function | null | (自定义 hook) 数据上报前的 hook，有值时，所有的上报数据都要经过该 hook 处理，若返回 false，该条数据不会上报 | | handleHttpStatus | function | null | (自定义 hook) 根据接口返回的 response 判断请求是否正确，返回 true 表示接口正常，反之表示接口报错(只有接口报错时才保留 response), 该函数的参数为 { url, response, requestData, elapsedTime, time, method, type, Status } |

默认监控配置项

| Name | Type | Default | Description | | :------------------------: | --------- | ------- | --------------------------------------------------------------------- | | silentXhr | boolean | true | 默认会监控 xhr，为 false 时，将不再监控 | | silentFetch | boolean | true | 默认会监控 fetch，为 false 时，将不再监控 | | silentClick | boolean | true | 默认会全局监听 click 点击事件，为 false | | silentError | boolean | true | 默认会监控 error，为 false 时，将不再监控 | | silentUnhandledrejection | boolean | true | 默认会监控 unhandledrejection，为 false 时，将不再监控 | | silentHistory | boolean | true | 默认会监控 popstate、pushState、replaceState，为 false 时，将不再监控 | | silentHashchange | boolean | true | 默认会监控 hashchange，为 false 时，将不再监控 | | silentPerformance | boolean | true | 默认会上报性能指标，为 false 时，将不再监控 |

web-see 前端监控文章

这几篇文章详细介绍了该 SDK 的项目架构、功能实现、前端录屏、白屏检测等技术点

从 0 到 1 搭建前端监控平台，面试必备的亮点项目
前端录屏+定位源码，帮你快速定位线上 bug
前端白屏的检测方案，让你知道自己的页面白了

错误去重

repeatCodeError 设置为 true 时，将开启一个缓存 map，存入已发生错误的 hash，上报错误时先判断该错误是否已存在，不存在则上报

在用户的一次会话中，如果产生了同一个错误，那么将这同一个错误上报多次是没有意义的； 在用户的不同会话中，如果产生了同一个错误，那么将不同会话中产生的错误进行上报是有意义的；

为什么有上面的结论呢？

在用户的同一次会话中，如果点击一个按钮出现了错误，那么再次点击同一个按钮，必定会出现同一个错误，而这出现的多次错误，影响的是同一个用户、同一次访问；所以将其全部上报是没有意义的； 而在同一个用户的不同会话中，如果出现了同一个错误，那么这不同会话里的错误进行上报就显得有意义了

web-see 根据错误堆栈信息，将错误信息、错误文件、错误行号聚合生成一个 hash 值，这个值是这个错误唯一性的 ID

// 对每一个错误详情，生成唯一的编码
export function getErrorUid(hash: string): string {
  return window.btoa(encodeURIComponent(hash));
}
const hash: string = getErrorUid(`${EVENTTYPES.ERROR}-${ev.message}-${fileName}-${columnNumber}`);

白屏检测功能说明

该功能用来检测页面打开后，是否一直处于白屏状态，通过 silentWhiteScreen 设为 true 来开启

白屏检测功能使用：关键点采样对比 + 白屏修正机制，来确保白屏功能的正确性

对于有骨架屏的项目，如果页面一直显示骨架屏，也算是白屏的一种，有骨架屏的项目建议 skeletonProject 设为 true，提高白屏检测准确性

自定义 hook 示例

handleHttpStatus

// 根据接口返回的response判断请求是否正确
import webSee from 'webSee';

Vue.use(webSee, {
  dsn: 'http://test.com/reportData',
  apikey: 'abcd',
  // handleHttpStatus 返回true表示接口正常，反之表示接口报错
  handleHttpStatus(data) {
    let { url, response } = data;
    // code为200，接口正常，反之亦然
    let { code } = typeof response === 'string' ? JSON.parse(response) : response;
    if (url.includes('/getErrorList')) {
      return code === 200 ? true : false;
    } else {
      return true;
    }
  },
});

beforePushBreadcrumb

// 添加用户行为
push(data) {
  if (typeof this.beforePushBreadcrumb === 'function') {
    /**
      * 执行用户自定义的hook，若返回false，则这条数据不添加到列表中
      * @param { object } this 当前用户行为的实例
      * @param { object } data 要添加到用户行为列表的数据
      */
    let result = this.beforePushBreadcrumb(data);
    if (!result) return;
    this.immediatePush(result);
    return;
  }
  this.immediatePush(data);
}

beforeDataReport

// 上报数据前的hook
async beforePost(data) {
  let transportData = this.getTransportData(data);
  /**
  * 执行用户自定义的hook，若返回false，则这条数据不会进行上报
  * @param { object } transportData 当前要上报的数据
  */
  if (typeof this.beforeDataReport === 'function') {
    transportData = this.beforeDataReport(transportData);
    if (!transportData) return false;
  }
  return transportData;
}

手动上报错误示例

import webSee from 'web-see';

webSee.log({
  type: 'custom',
  message: '手动报错信息',
  error: new Error('报错'),
});

演示

后台页面

演示效果

特别感谢

• haixin-fang
• wenzhu-eternal

监控 demo 仓库

web-see-demo