前端異常監(jiān)控window.onerror unhandledrejection

關于前端異常監(jiān)控办素,我們需要做到捕獲JS異常和代碼中未捕獲的promise異常,然后向服務器上報

捕獲JS異常

在了解捕獲JS異常前先了解下window.onerror語法

window.onerror = function(message, source, lineno, colno, error) { ... }

函數(shù)參數(shù):

  • message:錯誤信息(字符串)古徒。可用于HTML onerror=""處理程序中的event读恃。
  • source:發(fā)生錯誤的腳本URL(字符串)
  • lineno:發(fā)生錯誤的行號(數(shù)字)
  • colno:發(fā)生錯誤的列號(數(shù)字)
  • errorError對象(對象)

若該函數(shù)返回true隧膘,則阻止執(zhí)行默認事件處理函數(shù)。

window.addEventListener('error')節(jié)

window.addEventListener('error', function(event) { ... })

ErrorEvent 類型的event包含有關事件和錯誤的所有信息寺惫。

element.onerror節(jié)

element.onerror = function(event) { ... }

element.onerror使用單一Event參數(shù)的函數(shù)作為其處理函數(shù)疹吃。

我們可以看到函數(shù)正常是可以收集到錯誤字符串信息、發(fā)生錯誤的js文件西雀,錯誤所在的行數(shù)萨驶、列數(shù)、和Error對象(里面會有調(diào)用堆棧信息等)艇肴,把這些信息回傳到server端即可篡撵,再配合sourcemap的話我們就可以知道是源碼中的哪一行出錯了判莉,從而實現(xiàn)完美的錯誤實時監(jiān)控系統(tǒng)了。然而要完美還是需要做很多工作的育谬。

首先,我們的js文件一般都是和網(wǎng)站不同域的帮哈,這是為了提高頁面的渲染速度以及架構的可維護性(單獨CDN域名膛檀,充分利用瀏覽器http并發(fā)數(shù))。這樣的js文件中發(fā)生錯誤我們直接監(jiān)控你會發(fā)現(xiàn)你啥信息都收集不到娘侍。

實驗一:我們的站點是a.com咖刃,頁面中引用了兩個js文件,一個是a.com域名下的a.js憾筏,一個是b.com域名下的b.js嚎杨,我們在a.js文件中添加window.onerror監(jiān)控,在b.js文件中主動拋出錯誤

<!-- index.html  -->
<script type="text/javascript" src="http://a.com/a.js" ></script>
<script type="text/javascript" src="http://b.com/b.js" ></script>

// a.js
window.onerror = function (message, url, line, column, error) {
  console.log('log---onerror::::',message, url, line, column, error);
}

// b.js
throw new Error('this is the error happened in b.js');

我們可以看到下圖的結果氧腰,onerror函數(shù)拿到的信息是Script error, a 0 null枫浙,啥卵用都沒有,你完全不知道發(fā)生了什么錯誤古拴,哪個文件發(fā)生的錯誤箩帚。

這是瀏覽器的同源策略,當加載自不同域(協(xié)議黄痪、域名紧帕、端口三者任一不同)的腳本中發(fā)生語法(?)錯誤時,為避免信息泄露桅打,語法錯誤的細節(jié)將不會報告是嗜,而代之簡單的"Script error."

image

但是我們確實是需要知道發(fā)生錯誤的具體信息啊挺尾,不然監(jiān)控就沒有意義了鹅搪。既然又是類同源限制的問題,那肯定是可以通過CORS來解決了潦嘶。

實驗二:我們給b.js加上Access-Control-Allow-Origin:*的response header涩嚣,后面我們會發(fā)現(xiàn)還是沒啥變化。

image

實驗三:我們繼續(xù)給b.js加上crossorigin屬性掂僵,發(fā)現(xiàn)可以了航厚,想要的信息都收集到了,nice

<!-- index.html  -->
<script type="text/javascript" src="http://a.com/a.js" ></script>
<script type="text/javascript" src="http://b.com/b.js"  crossorigin></script>

image

結論:如果想通過onerror函數(shù)收集不同域的js錯誤锰蓬,我們需要做兩件事:

  1. 相關的js文件上加上Access-Control-Allow-Origin:*的response header
  2. 引用相關的js文件時加上crossorigin屬性

注意: 以上兩步缺一不可幔睬。實驗二告訴我們,如果只是加上Access-Control-Allow-Origin:*的話芹扭,錯誤還是無法捕獲麻顶。如果只加上crossorigin屬性赦抖,瀏覽器會報無法加載的錯誤,如下圖

image

可是辅肾。队萤。。
如果你使用sentry的raven.js的話矫钓,你會發(fā)現(xiàn)你什么都不用做要尔,他依然可以幫你捕獲到一些錯誤的非常具體信息,確實是有點神奇啊新娜,具體怎么做的赵辕?關鍵就是raven源碼中的install方法中調(diào)用的_instrumentTryCatch函數(shù)起了作用,他通過tryCatch的方式wrap了一些關鍵函數(shù)概龄,使得這些函數(shù)里的報錯能夠捕獲还惠,_instrumentTryCatch的具體實現(xiàn)原理我們后面再說

    install: function() {
        var self = this;

        if (self.isSetup() && !self._isRavenInstalled) {
            TraceKit.report.subscribe(function () {
                self._handleOnErrorStackInfo.apply(self, arguments);
            });
            if (self._globalOptions.instrument && self._globalOptions.instrument.tryCatch) {
              self._instrumentTryCatch();// 通過tryCatch來wrap關鍵函數(shù),從而獲得error的具體信息
            }

            if (self._globalOptions.autoBreadcrumbs)
                self._instrumentBreadcrumbs();

            // Install all of the plugins
            self._drainPlugins();

            self._isRavenInstalled = true;
        }

        Error.stackTraceLimit = self._globalOptions.stackTraceLimit;
        return this;
    },

其實如果你真的什么都不做私杜,raven也只是能捕獲一些異步錯誤蚕键,同步錯誤還是無法捕獲,所以你即使使用了sentry等第三方的錯誤收集庫歪今,你還是需要加上Access-Control-Allow-Origin:*和crossorigin屬性

image

捕獲未處理的promise異常

為了保證可讀性嚎幸,本文采用意譯而非直譯,并且對源代碼進行了大量修改寄猩。另外嫉晶,本文版權歸原作者所有,翻譯僅用于學習田篇。

使用Promise編寫異步代碼時替废,使用reject來處理錯誤。有時泊柬,開發(fā)者通常會忽略這一點椎镣,導致一些錯誤沒有得到處理。例如:

function main() {
    asyncFunc()
    .then(···)
    .then(() => console.log('Done!'));
}

這篇博客將分別介紹在瀏覽器與Node.js中兽赁,如何捕獲那些未處理的Promise錯誤状答。由于沒有使用catch方法捕獲錯誤,當asyncFunc()函數(shù)reject時刀崖,拋出的錯誤則沒有被處理惊科。

瀏覽器中未處理的Promise錯誤

一些瀏覽器(例如Chrome)能夠捕獲未處理的Promise錯誤。

unhandledrejection

監(jiān)聽unhandledrejection事件亮钦,即可捕獲到未處理的Promise錯誤:

window.addEventListener('unhandledrejection', event => ···);

promise: reject的Promise這個事件是PromiseRejectionEvent實例馆截,它有2個最重要的屬性:

  • reason: Promise的reject值

示例代碼:

window.addEventListener('unhandledrejection', event => {
    console.log(event.reason); 
});
function foo() {
    Promise.reject('Hello, Fundebug!');
}
foo();

當一個Promise錯誤最初未被處理,但是稍后又得到了處理,則會觸發(fā)rejectionhandled事件:

 window.addEventListener('rejectionhandled', event => ···);

示例代碼:這個事件是PromiseRejectionEvent實例蜡娶。

window.addEventListener('unhandledrejection', event =>
{
    console.log(event.reason); // 打印"Unhandle Promise Error!"
});
 
window.addEventListener('rejectionhandled', event => {
    console.log('rejection handled'); // 1秒后打印"rejection handled"
});
 
function foo() {
    return Promise.reject('Unhandle Promise Error!');
}
 
var r = foo();
 
setTimeout(() => {
    r.catch(e =>{});
}, 1000);

參考文獻:
GlobalEventHandlers.onerror
What the heck is "Script error"?

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末混卵,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子窖张,更是在濱河造成了極大的恐慌幕随,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,496評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件荤堪,死亡現(xiàn)場離奇詭異合陵,居然都是意外死亡,警方通過查閱死者的電腦和手機澄阳,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來踏拜,“玉大人碎赢,你說我怎么就攤上這事∷俟#” “怎么了肮塞?”我有些...
    開封第一講書人閱讀 162,632評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長姻锁。 經(jīng)常有香客問我枕赵,道長,這世上最難降的妖魔是什么位隶? 我笑而不...
    開封第一講書人閱讀 58,180評論 1 292
  • 正文 為了忘掉前任拷窜,我火速辦了婚禮,結果婚禮上涧黄,老公的妹妹穿的比我還像新娘篮昧。我一直安慰自己,他們只是感情好笋妥,可當我...
    茶點故事閱讀 67,198評論 6 388
  • 文/花漫 我一把揭開白布懊昨。 她就那樣靜靜地躺著,像睡著了一般春宣。 火紅的嫁衣襯著肌膚如雪酵颁。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,165評論 1 299
  • 那天月帝,我揣著相機與錄音躏惋,去河邊找鬼。 笑死嫁赏,一個胖子當著我的面吹牛其掂,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播潦蝇,決...
    沈念sama閱讀 40,052評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼款熬,長吁一口氣:“原來是場噩夢啊……” “哼深寥!你這毒婦竟也來了?” 一聲冷哼從身側響起贤牛,我...
    開封第一講書人閱讀 38,910評論 0 274
  • 序言:老撾萬榮一對情侶失蹤惋鹅,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后殉簸,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體闰集,經(jīng)...
    沈念sama閱讀 45,324評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,542評論 2 332
  • 正文 我和宋清朗相戀三年般卑,在試婚紗的時候發(fā)現(xiàn)自己被綠了武鲁。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,711評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡蝠检,死狀恐怖沐鼠,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情叹谁,我是刑警寧澤饲梭,帶...
    沈念sama閱讀 35,424評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站焰檩,受9級特大地震影響憔涉,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜析苫,卻給世界環(huán)境...
    茶點故事閱讀 41,017評論 3 326
  • 文/蒙蒙 一兜叨、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧藤违,春花似錦浪腐、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至璧榄,卻和暖如春特漩,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背骨杂。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評論 1 269
  • 我被黑心中介騙來泰國打工涂身, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人搓蚪。 一個月前我還...
    沈念sama閱讀 47,722評論 2 368
  • 正文 我出身青樓蛤售,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子悴能,可洞房花燭夜當晚...
    茶點故事閱讀 44,611評論 2 353

推薦閱讀更多精彩內(nèi)容

  • 為什么要做前端異常監(jiān)控 有些問題只存在于線上特定的環(huán)境 后端錯誤有監(jiān)控揣钦,前端錯誤沒有監(jiān)控 基本實現(xiàn) 參考我們nod...
    2林子易2閱讀 6,990評論 0 9
  • 一冯凹、為什么要處理異常? 異常是不可控的炒嘲,會影響最終的呈現(xiàn)結果宇姚,但是我們有充分的理由去做這樣的事情。 1夫凸、增強用戶體...
    grain先森閱讀 1,361評論 1 38
  • 現(xiàn)行有一些已經(jīng)開源的前端異常監(jiān)控庫浑劳,如騰訊的badJs,全棧js監(jiān)控fundebug夭拌,國外的sentry等呀洲。 錯誤...
    滾石_c2a6閱讀 4,000評論 3 0
  • 本文適用的讀者 本文寫給有一定Promise使用經(jīng)驗的人,如果你還沒有使用過Promise啼止,這篇文章可能不適合你,...
    HZ充電大喵閱讀 7,305評論 6 19
  • 忍耐久了就一定會像火山爆發(fā)
    成長記錄而已閱讀 199評論 0 1