在NodeJS中使用domain模块捕获异步异常

背景

最近,线上有一个重要服务发生了宕机,导致上课中的教师大面积的断线。我们通过错误日志,查到一个 socket hang up 报错。但是无法根据错误定位到异常的代码。通过查询访问日志,也无法定位到宕机前发生错误的接口。我们期望能在代码里对异常进行捕获,这样不会导致服务挂掉,还希望获取异常的上下文,以便定位错误。

events.js:183
      throw er; // Unhandled 'error' event
      ^

Error: socket hang up
    at TLSSocket.onHangUp (_tls_wrap.js:1137:19)
    at Object.onceWrapper (events.js:313:30)
    at emitNone (events.js:111:20)
    at TLSSocket.emit (events.js:208:7)
    at endReadableNT (_stream_readable.js:1064:12)
    at _combinedTickCallback (internal/process/next_tick.js:138:11)
    at process._tickCallback (internal/process/next_tick.js:180:9)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! lesson@1.0.0 start: `node ./app/bin/www;`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the lesson@1.0.0 start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2018-09-30T08_22_32_703Z-debug.log

使用uncaughtException捕获异步异常

首先,我们想到了 process上的 uncaughtException 事件。只要给 process 的uncaughtException事件注册了回调,服务就不会异常退出。看起来十分美好,起码我们的服务不会挂掉了。但是,带来了其他问题。

uncaughtException 事件

uncaughtException,是NodeJS进程(Process)中的一个事件。如果进程中发生了一个异常且异常没有被任何try...catch进行捕获就会触发这个事件。

下面以同步异常为例,介绍一下NodeJS对异常的默认处理。

process.on('uncaughtException', (error) => {
  console.log('call uncaughtException handle');
});

// 执行一个不存在的异常
nonexistentFunc();

首先,我们注册process的uncaughtException事件,然后执行了一个不存在的函数。当执行这段程序时,程序会因为函数nonexistentFunc不存在,而抛出异常。由于没有进行try...catch...处理,异常将会冒泡直到事件循环为止。NodeJS对于异常的默认处理,类似代码如下:

function _MyFatalException(err){
    if(!process.emit('uncaughtException',err)){
        console.error(err.stack);
        process.emit('exit',1);
    }
}

NodeJS对于异常的默认处理的顺序是,首先触发 uncaughtException事件,若事件没有被监听到,则打印堆栈的错误信息,最后调用进程的退出事件。若事件监听到,则处理uncaughtException的注册回调。

uncaughtException 事件发生的条件

  1. 当程序发生了异常
  2. 且异常未被 try...catch捕获

缺点与问题

  1. 无法获取异常的上下文。
  2. 无法给出友好的异常处理。例如,当接口发生 uncaughtException 时,无法获取到 response对象(已经丢失了上下文),告知调用方服务当前出现异常。
  3. 会导致内存泄露。uncaughtException事件发生后,会丢失当前环境的堆栈,可能导致Node不能正常进行内存回收,从而导致内存泄露。

由于使用 uncaughtException捕获异常,会导致内存泄露。建议的使用方式为,当 uncaughtException事件发生时,记录error,然后结束 Node 进程进行重启服务。(😭然后我们在项目中并没有这样做。。。业务不允许重启。。)

使用domain模块捕获异步异常

注意:domain模块将被弃用。

domain 模块,简化了异常的处理方式,可以处理try...catch..无法捕获的异常。且不会丢失上下文,也不会导致程序退出。

我们老项目使用的是 express 框架,因此可以使用中间件的方式,处理请求中的异步异常。代码如下:

const domain = require('domain');

app.use((req, res, next) => {
  const req_domain = domain.create();

  req_domain.on('error', (err) => {
    console.log(err);  // 打印错误日志
    res.send(500, err.stack);
  });

  req_domain.run(next);
});

在中间件中,首先创建一个 domain对象,然后注册 error 事件的回调,最后在创建域的上下文中执行next函数。

什么时候触发domain的error事件:
进程抛出了异常,没有被任何的try catch捕获到,这时候将会触发整个process的processFatal,此时如果在domain包裹之中,将会在domain上触发error事件,反之,将会在process上触发uncaughtException事件。

如果想要了解更多关于 domain 模块,可以阅读这篇文章——《Node.js 异步异常的处理与domain模块解析》

优化方案

domain虽然很好用,但不是万能的。有时,也无法捕获部分异常。为了保证服务不会挂掉。我可以使用 uncaughtException事件进行兜底。

基础版

domain + uncaughtException

domain 来捕获大部分异常和合理处理异常退出,uncaughtException 来避免服务挂掉。

升级版

domain + uncaughtException + Cluster

我们可以使用Cluster模块,开启多个工作线程。当遇到domain无法捕获的异常,在 uncaughtException 捕获到时,为了避免内存泄露,我们可以结束当前work进程。具体实现如下:

const cluster = require('cluster');

process.on('uncaughtException', (err) => {

  console.log(err); // 将异常写入日志

  server.close(); // 关闭服务连接

  // 通知 master 进程停止服务
  if (cluster.worker) {
      cluster.worker.disconnect();
  }

});

总结

尽管domain模块即将废弃,但是我们仍然可以使用它,发现和定位线上异常。

参考资料

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 142,461评论 1 300
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 61,089评论 1 256
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 94,078评论 0 212
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 40,938评论 0 175
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,698评论 1 255
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,733评论 1 175
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,340评论 2 268
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,138评论 0 165
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,949评论 6 229
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,493评论 0 213
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,269评论 2 214
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,591评论 1 229
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,216评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,107评论 2 213
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,485评论 3 204
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,615评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,006评论 0 167
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,496评论 2 230
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,572评论 2 230

推荐阅读更多精彩内容

  • 本文的主要内容是对nodejs提供的一些重要模块,结合官方API进行介绍,遇到精彩的文章,我会附在文中并标明了出处...
    艾伦先生阅读 1,076评论 0 13
  • 记得刚刚开始学Node.js时自己尝试着写了一个简单的http服务器,跟以前接触过的php相比感觉更自由,编起码来...
    淘小杰阅读 1,377评论 0 5
  • https://nodejs.org/api/documentation.html 工具模块 Assert 测试 ...
    KeKeMars阅读 6,202评论 0 6
  • JS常见错误 当 JavaScript 引擎执行 JavaScript 代码时,会发生各种错误,常见的错误类型有 ...
    Sunny_杰少阅读 1,253评论 0 1
  • process --进程 process对象是一个全局对象,他提供当前Node.js进程相关的有关信息,以及控制当...
    imakan阅读 4,563评论 0 3