如何使用Restify的RequestLogger？

Question

RequestLogger

設置填充當前請求ID的子bunyan記錄器，以及您定義的任何其他參數。

server.use(restify.requestLogger());

注冊插件不會記錄請求。

Answer 1

RequestLogger插件不記錄每個請求。 它擴展了req的.log屬性 ：

這樣做的好處是每個restify req實例都有一個新的bunyan實例日志，其中自動注入請求ID，因此您可以輕松地將高吞吐量日志關聯在一起。

您必須先注冊自己的記錄器，例如

var restify = require('restify'),
    bunyan = require('bunyan'),
    // Create a logger.
    log = bunyan.createLogger({name: 'showtime'}),
    server;

// Register logger.
server = restify.createServer({
    log: log
});

// Extend logger using the plugin.
server.use(restify.requestLogger());

// Use req.log property as a regular instance of bunyan logger.
server.use(function (req, res, next) {
    req.log.info('TEST');
    next();
});

server.get('/ping', function (req, res, next) {
    res.send('pong');
    next();
});

server.listen(8080);

向/ping端點發出一些請求將產生以下日志：

{"name":"showtime","hostname":"localhost.localdomain","pid":6446,"req_id":"3c734e70-81de-11e4-bc58-e3e7254ff287","level":30,"msg":"TEST","time":"2014-12-12T09:07:02.488Z","v":0}
{"name":"showtime","hostname":"localhost.localdomain","pid":6446,"req_id":"3d6bdf40-81de-11e4-bc58-e3e7254ff287","level":30,"msg":"TEST","time":"2014-12-12T09:07:04.116Z","v":0}
{"name":"showtime","hostname":"localhost.localdomain","pid":6446,"req_id":"3df47030-81de-11e4-bc58-e3e7254ff287","level":30,"msg":"TEST","time":"2014-12-12T09:07:05.011Z","v":0}

注意“req_id”屬性。

沒有requestLogger代碼的等效請求

server.use(restify.requestLogger({
    log: log,
    serializers: restify.bunyan.serializers
}));

將產生以下日志：

{"name":"showtime","hostname":"localhost.localdomain","pid":6448,"level":30,"msg":"TEST","time":"2014-12-12T09:07:23.099Z","v":0}
{"name":"showtime","hostname":"localhost.localdomain","pid":6448,"level":30,"msg":"TEST","time":"2014-12-12T09:07:24.527Z","v":0}
{"name":"showtime","hostname":"localhost.localdomain","pid":6448,"level":30,"msg":"TEST","time":"2014-12-12T09:07:24.674Z","v":0}

如果您的目的是記錄每一個請求，那么就放棄了

server.use(function (req, res, next) {
    req.log.info('TEST');
    next();
});

支持：

server.on('after', restify.auditLogger({
    log: log
}));

這將產生日志：

{"name":"showtime","hostname":"localhost.localdomain","pid":6451,"audit":true,"level":30,"remoteAddress":"192.168.100.1","remotePort":58986,"req_id":"00093110-81df-11e4-981e-e3d13800c8bf","req":{"method":"GET","url":"/ping","headers":{"user-agent":"curl/7.37.1","host":"192.168.100.100:8080","accept":"*/*"},"httpVersion":"1.1","trailers":{},"version":"*","timers":{"bunyan":378,"handler-1":3044}},"res":{"statusCode":200,"headers":{"content-type":"application/json","content-length":6},"trailer":false},"latency":6,"_audit":true,"msg":"handled: 200","time":"2014-12-12T09:12:30.629Z","v":0}
{"name":"showtime","hostname":"localhost.localdomain","pid":6451,"audit":true,"level":30,"remoteAddress":"192.168.100.1","remotePort":58989,"req_id":"2b2fcac0-81df-11e4-981e-e3d13800c8bf","req":{"method":"GET","url":"/ping","headers":{"user-agent":"curl/7.37.1","host":"192.168.100.100:8080","accept":"*/*"},"httpVersion":"1.1","trailers":{},"version":"*","timers":{"bunyan":105,"handler-1":607}},"res":{"statusCode":200,"headers":{"content-type":"application/json","content-length":6},"trailer":false},"latency":1,"_audit":true,"msg":"handled: 200","time":"2014-12-12T09:13:43.021Z","v":0}
{"name":"showtime","hostname":"localhost.localdomain","pid":6451,"audit":true,"level":30,"remoteAddress":"192.168.100.1","remotePort":58990,"req_id":"2b6532a0-81df-11e4-981e-e3d13800c8bf","req":{"method":"GET","url":"/ping","headers":{"user-agent":"curl/7.37.1","host":"192.168.100.100:8080","accept":"*/*"},"httpVersion":"1.1","trailers":{},"version":"*","timers":{"bunyan":7067,"handler-1":677}},"res":{"statusCode":200,"headers":{"content-type":"application/json","content-length":6},"trailer":false},"latency":8,"_audit":true,"msg":"handled: 200","time":"2014-12-12T09:13:43.371Z","v":0}