查看原文
其他

【第1915期】如何监控网页崩溃?

前端外刊评论 前端早读课 2021-01-28

前言

今日早读文章由字节跳动@寸志授权分享。

正文从这开始~~

崩溃和卡顿有何差别?

卡顿也就是网页暂时响应比较慢,JS 可能无法及时执行,这也是网页卡顿监控所依赖的技术点。

但崩溃就不一样了,网页都崩溃了,页面看不见了,JS 都不运行了,还有什么办法可以监控网页的崩溃,并将网页崩溃上报呢?

但,天无绝人之路,方法总是有的。

load 与 beforeunload 事件

搜遍互联网,几乎找不到方法,最终碰上了这篇文章。本文利用 window 对象的 load 和 beforeunload 事件实现了网页崩溃的监控。http://jasonjl.me/blog/2015/06/21/taking-action-on-browser-crashes/

  1. window.addEventListener('load', function () {

  2. sessionStorage.setItem('good_exit', 'pending');

  3. setInterval(function () {

  4. sessionStorage.setItem('time_before_crash', new Date().toString());

  5. }, 1000);

  6. });


  7. window.addEventListener('beforeunload', function () {

  8. sessionStorage.setItem('good_exit', 'true');

  9. });


  10. if(sessionStorage.getItem('good_exit') &&

  11. sessionStorage.getItem('good_exit') !== 'true') {

  12. /*

  13. insert crash logging code here

  14. */

  15. alert('Hey, welcome back from your crash, looks like you crashed on: ' + sessionStorage.getItem('time_before_crash'));

  16. }

一图胜千言:

使用 load 和 beforeunload 事件实现崩溃监控

这个方案巧妙的利用了页面崩溃无法触发 beforeunload 事件来实现的。

在页面加载时(load 事件)在 sessionStorage 记录 goodexit 状态为 pending,如果用户正常退出(beforeunload 事件)状态改为 true,如果 crash 了,状态依然为 pending,在用户第2次访问网页的时候(第2个load事件),查看 goodexit 的状态,如果仍然是 pending 就是可以断定上次访问网页崩溃了!

但这个方案有问题:

  • 采用 sessionStorage 存储状态,但通常网页崩溃/卡死后,用户会强制关闭网页或者索性重新打开浏览器,sessionStorage 存储但状态将不复存在;

  • 如果将状态存储在 localStorage 甚至 Cookie 中,如果用户先后打开多个网页,但不关闭,good_exit 存储的一直都是 pending,完了,每有一次网页打开,就会有一个 crash 上报。

全民直播 一开始采用的就是这个方案,发现就算页面做了优化,crash 不下降,与 PV 保持比例,才意识到这个方案的问题之处。

基于 Service Worker 的崩溃统计方案

随着 PWA 概念的流行,大家对 Service Worker 也逐渐熟悉起来。基于以下原因,我们可以使用 Service Worker 来实现网页崩溃的监控:

  • Service Worker 有自己独立的工作线程,与网页区分开,网页崩溃了,Service Worker 一般情况下不会崩溃;

  • Service Worker 生命周期一般要比网页还要长,可以用来监控网页的状态;

  • 网页可以通过 navigator.serviceWorker.controller.postMessage API 向掌管自己的 SW 发送消息。

基于以上几点,我们可以实现一种基于心跳检测的监控方案:

p1:网页加载后,通过 postMessage API 每 5s 给 sw 发送一个心跳,表示自己的在线,sw 将在线的网页登记下来,更新登记时间;

p2:网页在 beforeunload 时,通过 postMessage API 告知自己已经正常关闭,sw 将登记的网页清除;

p3:如果网页在运行的过程中 crash 了,sw 中的 running 状态将不会被清除,更新时间停留在奔溃前的最后一次心跳;

sw:Service Worker 每 10s 查看一遍登记中的网页,发现登记时间已经超出了一定时间(比如 15s)即可判定该网页 crash 了。

一些简化后的检测代码,给大家作为参考:

  1. // 页面 JavaScript 代码

  2. if (navigator.serviceWorker.controller !== null) {

  3. let HEARTBEAT_INTERVAL = 5 * 1000; // 每五秒发一次心跳

  4. let sessionId = uuid();

  5. let heartbeat = function () {

  6. navigator.serviceWorker.controller.postMessage({

  7. type: 'heartbeat',

  8. id: sessionId,

  9. data: {} // 附加信息,如果页面 crash,上报的附加数据

  10. });

  11. }

  12. window.addEventListener("beforeunload", function() {

  13. navigator.serviceWorker.controller.postMessage({

  14. type: 'unload',

  15. id: sessionId

  16. });

  17. });

  18. setInterval(heartbeat, HEARTBEAT_INTERVAL);

  19. heartbeat();

  20. }

sessionId 本次页面会话的唯一 id;

postMessage 附带一些信息,用于上报 crash 需要的数据,比如当前页面的地址等等。

  1. const CHECK_CRASH_INTERVAL = 10 * 1000; // 每 10s 检查一次

  2. const CRASH_THRESHOLD = 15 * 1000; // 15s 超过15s没有心跳则认为已经 crash

  3. const pages = {}

  4. let timer

  5. function checkCrash() {

  6. const now = Date.now()

  7. for (var id in pages) {

  8. let page = pages[id]

  9. if ((now - page.t) > CRASH_THRESHOLD) {

  10. // 上报 crash

  11. delete pages[id]

  12. }

  13. }

  14. if (Object.keys(pages).length == 0) {

  15. clearInterval(timer)

  16. timer = null

  17. }

  18. }


  19. worker.addEventListener('message', (e) => {

  20. const data = e.data;

  21. if (data.type === 'heartbeat') {

  22. pages[data.id] = {

  23. t: Date.now()

  24. }

  25. if (!timer) {

  26. timer = setInterval(function () {

  27. checkCrash()

  28. }, CHECK_CRASH_INTERVAL)

  29. }

  30. } else if (data.type === 'unload') {

  31. delete pages[data.id]

  32. }

  33. })

都挺简单的代码,不细说了。

方案的可行性

兼容性

Service Worker 的普及率已经相当高了,鉴于国内各种浏览器都是 Chrome 内核,而且版本已经在 Chrome 45 以上,已经覆盖了相当一部分用户。作为监控,数据覆盖大部分就好。

Service Worker 兼容性
可靠性

这应该是我目前已知可以相对准确判断出网页崩溃的方式了。不过我们的方案还在测试环境,上线一段时间后再给大家共享数据。

对浏览器厂商的建议

题图的 Crash 列表,可以在 Chrome 中访问 chrome://crashes/ 看到,如果厂商可以提供一个 API,在页面打开时,可以获知用户上一次崩溃的信息就很棒了!

关于本文 作者:@寸志 原文:https://zhuanlan.zhihu.com/p/40273861

为你推荐


【第1850期】网页布局简史


【第1661期】Node.js环境性能监控


【第1316期】大前端时代前端监控的最佳实践


    您可能也对以下帖子感兴趣

    文章有问题?点此查看未经处理的缓存