Sentry的前端异常监控方案

Sentry的异常信息收集方式分为两种,一种为自动收集,另一种为业务项目中手动收集,我们暂时只研究自动收集的方式。

异常监控收集的数据类型

首先定位到代码的instrument方法,可以看到全局自动收集的数据类型有以下几种:

  • console
  • dom
  • xhr
  • fetch
  • history
  • error
  • unhandledrejection
/** Instruments given API */
function instrument(type: InstrumentHandlerType): void {
  if (instrumented[type]) {
    return;
  }

  instrumented[type] = true;

  switch (type) {
    case 'console': // console的信息
      instrumentConsole();
      break;
    case 'dom':
      instrumentDOM(); // 监听并记录dom上的click keyPress事件
      break;
    case 'xhr': // xhr请求信息
      instrumentXHR();
      break;
    case 'fetch': // fetch请求信息
      instrumentFetch();
      break;
    case 'history':// 浏览器行为记录(点击后退 前进按钮)
      instrumentHistory();
      break;
    case 'error': // 全局window.onerror事件 监听js运行错误
      instrumentError();
      break;
    case 'unhandledrejection': // Promise 异常
      instrumentUnhandledRejection();
      break;
    default:
      logger.warn('unknown instrumentation type:', type);
  }
}

接下来我们重点研究一下 error unhandledrejection 以及 fetch xhr

window.onerror

window.onerror主要收集的是js代码运行时的全局异常.此处代码简单来说就是把原有的window.onerror包了一层,主要收集的信息有:
* msg:错误信息(字符串)。可用于HTML onerror=""处理程序中的event
* url:发生错误的脚本URL(字符串)
* line:发生错误的行号(数字)
* column:发生错误的列号(数字)
* error:Error对象(对象)或 其他类型

let _oldOnErrorHandler: OnErrorEventHandler = null;
/** JSDoc */
function instrumentError(): void {
  _oldOnErrorHandler = global.onerror;
  global.onerror = function (msg: any, url: any, line: any, column: any, error: any): boolean {
    triggerHandlers('error', {
      column,
      error,
      line,
      msg,
      url,
    });

    if (_oldOnErrorHandler) {
      return _oldOnErrorHandler.apply(this, arguments);
    }
    return false;
  };
}

window.unhandleRejection

当 Promise 被 reject 且没有 reject 处理器的时候,会触发 unhandledrejection 事件;

处理方式与window.onerror相似,都是包了一层

let _oldOnUnhandledRejectionHandler: ((e: any) => void) | null = null;
/** JSDoc */
function instrumentUnhandledRejection(): void {
  _oldOnUnhandledRejectionHandler = global.onunhandledrejection;

  global.onunhandledrejection = function (e: any): boolean {
    triggerHandlers('unhandledrejection', e);
    if (_oldOnUnhandledRejectionHandler) {
      return _oldOnUnhandledRejectionHandler.apply(this, arguments);
    }
    return true;
  };
}

xhr

从下面的代码可以看出,主要对xhr 原型链上的send 以及open方法进行改写,但是需要注意的是此处并没有只收集异常信息,也不能捕获到接口404 500等信息(需手动收集)

function instrumentXHR(): void {
  // 部分代码已做删减
  const xhrproto = XMLHttpRequest.prototype;

  fill(xhrproto, 'open', function (originalOpen: () => void): () => void {
    return function (this: SentryWrappedXMLHttpRequest, ...args: any[]): void {
      const xhr = this;

      const onreadystatechangeHandler = function (): void {
        if (xhr.readyState === 4) {
          if (xhr.__sentry_xhr__) {
              xhr.__sentry_xhr__.status_code = xhr.status;
            }
          triggerHandlers('xhr', {
            args,
            endTimestamp: Date.now(),
            startTimestamp: Date.now(),
            xhr,
          });
        }
      };

      if ('onreadystatechange' in xhr && typeof xhr.onreadystatechange === 'function') {
        fill(xhr, 'onreadystatechange', function (original: WrappedFunction): Function {
          return function (...readyStateArgs: any[]): void {
            onreadystatechangeHandler();
            return original.apply(xhr, readyStateArgs);
          };
        });
      } else {
        xhr.addEventListener('readystatechange', onreadystatechangeHandler);
      }

      return originalOpen.apply(xhr, args);
    };
  });

  fill(xhrproto, 'send', function (originalSend: () => void): () => void {
    return function (this: SentryWrappedXMLHttpRequest, ...args: any[]): void {
      triggerHandlers('xhr', {
        args,
        startTimestamp: Date.now(),
        xhr: this,
      });
      return originalSend.apply(this, args);
    };
  });
}

fetch

相比起xhr,fetch的数据捕获流程就显得比较干净清晰得多(fetch本身是基于promise的)。我们可以比较容易的看出,fetch请求记录的就是请求的 method url 起始时间 结束时间 请求返回的信息,以及错误信息

function instrumentFetch(): void {
  fill(global, 'fetch', function (originalFetch: () => void): () => void {
    return function (...args: any[]): void {
      const handlerData = {
        args,
        fetchData: {
          method: getFetchMethod(args),
          url: getFetchUrl(args),
        },
        startTimestamp: Date.now(),
      };

      triggerHandlers('fetch', {
        ...handlerData,
      });
      return originalFetch.apply(global, args).then(
        (response: Response) => { // 记录正常请求的信息
          triggerHandlers('fetch', {
            ...handlerData,
            endTimestamp: Date.now(),
            response,
          });
          return response;
        },
        (error: Error) => { // 记录异常请求的信息
          triggerHandlers('fetch', {
            ...handlerData,
            endTimestamp: Date.now(),
            error,
          });
          throw error;
        },
      );
    };
  });
}

总结

毫无意外,我们可以看出自动收集的错误信息,都是通过代理的方式,将原有的window.xx方法包裹一层,进行改写。其实在研究之前也大概猜到了,但是毕竟个人的经验有限,很难比较全面地了解到具体收集哪些方面的信息,这次通过sentry算是清晰了整体的脉络。


111 声望
12 粉丝
0 条评论
推荐阅读
对生活的态度
咯咯哒已经半岁多了,小家伙一天天长大,我在想除了物质上的保证,我还有什么可以给他的。于是我尝试着写下我近三十年的人生经验中,可以作为人生建议的一些东西送给他。

notself阅读 329

从零搭建 Node.js 企业级 Web 服务器(零):静态服务
过去 5 年,我前后在菜鸟网络和蚂蚁金服做开发工作,一方面支撑业务团队开发各类业务系统,另一方面在自己的技术团队做基础技术建设。期间借着 Node.js 的锋芒做了不少 Web 系统,有的至今生气蓬勃、有的早已夭折...

乌柏木141阅读 11.9k评论 10

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木60阅读 6k评论 16

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs39阅读 6.2k评论 12

封面图
从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木39阅读 7.1k评论 6

CSS 绘制一只思否猫
欢迎关注我的公众号:前端侦探练习 CSS 有一个比较有趣的方式,就是发挥想象,绘制各式各样的图案,比如来绘制一只思否猫?思否猫,SegmentFault 思否的吉祥物,是一只独一无二、特立独行、热爱自由的(>^ω^&lt...

XboxYan42阅读 2.8k评论 14

封面图
还在用 JS 做节流吗?CSS 也可以防止按钮重复点击
举个例子:一个保存按钮,为了避免重复提交或者服务器考虑,往往需要对点击行为做一定的限制,比如只允许每300ms提交一次,这时候我想大部分同学都会到网上直接拷贝一段throttle函数,或者直接引用lodash工具库

XboxYan34阅读 2.2k评论 2

封面图
111 声望
12 粉丝
宣传栏