bunyan log.child正确用例?

时间:2015-05-04 21:51:41

标签: javascript node.js logging express bunyan

我一直在寻找bunyan登录我的nodejs应用程序。我试了一下,一切似乎都很好。我在log.child上跳过了a section,但现在我正在尝试了解如何使用它。我认为它的目的是允许我为日志条目指定一些特殊标识符,以便我可以唯一地标识该日志与其他日志条目的关联方式。

如果是这种情况,我会设想自己在每个请求中使用log.child

var bunyan = require('bunyan');
var log = bunyan.createLogger({name: 'myapp'});

router.post('/submit', function(req, res) {
    var logChild = log.child({reqId: uuid.v4()});
    logChild.info({ req:req }, req.user.name + ' has called /submit');

    saveData(req)
    .then(function(data) {
        logChild.info({data: data}, req.user.name + ' has saved to DB successfully in /submit');
        res.json({'success': 'Saved!'});
    })
    .error(function(err) {
        logChild.error({ err: err }, req.user.name + ' has caused an error in /submit ');
        res.status(500).json("error": err});
    }); 
});

这样,如果用户Bob在30秒范围内向/submit发送两次POST,则会有一些上下文区分日志文件中的两个不同调用。

也就是说,我会看到类似的内容(带上下文):

Bob has called /submit uuid: 109156be-c4fb-41ea-b1b4-efe1671c5836
Bob has called /submit uuid: 49dlsd7i-dapd-fdio-fei0-sd59fd0ph34d
Bob has saved to DB successfully in /submit uuid: 109156be-c4fb-41ea-b1b4-efe1671c5836
Bob has caused an error in /submit uuid: 49dlsd7i-dapd-fdio-fei0-sd59fd0ph34d

而不是这个(没有上下文):

Bob has called /submit
Bob has called /submit
Bob has saved to DB successfully in /submit
Bob has caused an error in /submit

对于我的Nodejs应用程序中的所有路由,我将创建logChild对象,然后使用logChild记录该路由中的条目。

我是否理解正确实施 log.child的用例?

1 个答案:

答案 0 :(得分:10)

您似乎正在适当地使用log.child。我可以通过将log附加到req对象来帮助您“唯一地识别该日志与其他日志条目的关联方式”的一个建议。这样,如果您有不同的中间件,则可以从多个位置访问具有相同唯一ID的同一记录器。例如:

var log = bunyan.createLogger({name: 'myapp'});

router.use(function(req, res, next) {
    req.log = log.child({ user : req.user.id });
});

router.post('/submit', function(req, res) {
    req.log.info('submitted request at ' + Date.now());
});

现在,您将在日志中看到{ user : some_user_id, msg: 'submitted request at 01/03/15' },这样您就可以使用req.log对象将请求链中的任何中间件绑定到单个用户。