Node.js 是運行在服務端的 JavaScript 平台,而任何服務端應用都離不開一套可靠的錯誤收集機制。本文說明如何透過 raygun4node 套件,把 Node.js 程式的例外訊息送到 Raygun 平台上統一管理。
套件可以透過 npm 直接安裝:
npm install raygun
安裝完成後會得到一個 Raygun 客戶端物件,用它設定 API key,就能手動送出錯誤訊息:
var raygun = require('raygun');
var raygunClient = new raygun.Client().init({ apiKey: 'your API key' });
當然,沒人想為每一段程式手動埋不入error 回報。若你的專案使用 Express,直接掛上它的中介軟體即可:
var raygun = require('raygun');
var raygunClient = new raygun.Client().init({ apiKey: 'your API key' });
app.use(raygunClient.expressHandler);
另一種常見做法是監聽 uncaughtException:
process.on('uncaughtException', function(err) {
raygunClient.send(err);
});
但這裡有個必須理解的代價。當事件迴圈回到頂端時這個事件才會觸發;一旦你註冊了監聽器,Node 的預設行為(印出呼叫堆疊並結束行程)就不會發生。也就是說,程式會繼續運行,但此時的 Node 行程其實處於未定義的狀態,狀態可能已經不一致。Node 官方文件明確表示不建議這樣做,未來也可能移除。
較恰當的替代方案是用 domain 把每個請求包成獨立的錯誤範圍,在裡面攔截例外、回報、清理,然後結束回應:
var domain = require('domain');
var raygun = require('raygun');
var raygunClient = new raygun.Client().init({ apiKey: 'your API key' });
var server = require('http').createServer(function (req, res) {
var d = domain.create();
d.on('error', function (err) {
raygunClient.send(err);
// 在這裡進行清理並結束回應
});
d.add(req);
d.add(res);
d.run(function () {
// 處理 req、res
});
});
server.listen(3000);
Raygun 的接入成本很低,真正的功課在於「錯誤發生後要怎麼收尾」。把錯誤範圍限制在單一請求層級,才能既保留完整的堆疊資訊,又不讓整個行程陷入無法預期的狀態。值得一提的是,domain 在後續的 Node 版本中已被標記為不建議使用,實務上新專案多半會改用 async_hooks 或 outright 的行程隔離與重啟策略來達到類似效果。