NodeJS Express - 全球唯一请求ID

时间:2016-04-26 21:03:19

标签: node.js express logging winston

是否可以定义每个日志语句中包含的唯一请求ID,而无需将记录器交给每个方法/函数调用?

使用的技术:NodeJS,Express,Winston

3 个答案:

答案 0 :(得分:8)

<强>被修改

最后,我创建了一个可以完成所有工作的库。 https://github.com/davicente/express-logger-unique-req-id

它是Winston库的包装器,因此您可以以相同的方式使用它。

让我知道它是否有助于你

我们在几个项目中遇到了同样的问题,但我无法找到这个问题的完整解决方案。我们使用相同的技术(Node.js,Express.js和Winston用于日志) 我找到了一个使用几个库并包装Winston库的解决方案: - node-uuid,用于为每个请求创建唯一标识符 - continuation-local-storage,用于在不同模块之间共享此ID,而不在所有调用中发送req对象。

首先,我需要为每个请求创建和设置唯一标识符。我是在中间件中做到的:

var uuid = require('node-uuid');
var createNamespace = require('continuation-local-storage').createNamespace;
var myRequest = createNamespace('my request');

// Run the context for each request. Assign a unique identifier to each request
app.use(function(req, res, next) {
    myRequest.run(function() {
        myRequest.set('reqId', uuid.v1());
        next();
    });
});

之后我不得不包装Winston库,从上下文中恢复id并添加到日志的消息中:

var winston = require('winston');
var getNamespace = require('continuation-local-storage').getNamespace;

// Wrap Winston logger to print reqId in each log
var formatMessage = function(message) {
    var myRequest = getNamespace('my request');
    message = myRequest && myRequest.get('reqId') ? message + " reqId: " + myRequest.get('reqId') : message;
    return message;
};

var logger = {
    log: function(level, message) {
        winstonLogger.log(level, formatMessage(message));
    },
    error: function(message) {
        winstonLogger.error(formatMessage(message));
    },
    warn: function(message) {
        winstonLogger.warn(formatMessage(message));
    },
    verbose: function(message) {
        winstonLogger.verbose(formatMessage(message));
    },
    info: function(message) {
        winstonLogger.info(formatMessage(message));
    },
    debug: function(message) {
        winstonLogger.debug(formatMessage(message));
    },
    silly: function(message) {
        winstonLogger.silly(formatMessage(message));
    }
};
module.exports = logger;

我认为这有点复杂,所以我决定把它写在一篇文章中。您可以从那里获得更多信息:Express.js: Logging info with global unique request ID – Node.js

我希望这有助于解决您的问题。

答案 1 :(得分:4)

This answer有一个问题:每次重新启动节点进程时,计数器都会返回0。事实证明,解决这个问题相当简单。您只需使用UUID包添加一个快速中间件,该中间件使用uuid标记每个请求。

对于uuid Pre-2.0

const uuid = require('uuid');
const app = express();
app.use(function (req, next) {
  req.id = uuid.v4();
  next();
});

对于uuid 3.0 +

const uuidv4 = require('uuid/v4');
const app = express();
app.use(function (req, next) {
  req.id = uuidv4();
  next();
});

答案 2 :(得分:0)

在请求处理的最开始,添加如下内容(或将其放在自己的文件中):

var makeID = (function() {
  var index = 0;
  return function() {
   return index++;
  }
})();

app.use(function(req, res, next) {
  req.id = makeID()
  next()
})

这将为每个请求提供唯一(顺序)ID。 不要让人们用它来识别自己,只在内部使用它!

登录Winston时,您可以输入元数据,以便在消息之后显示(格式为${name}=${value}),如下所示

app.use(function(req, res) {
  winston.log('info', 'Test Log Message', { id: req.id });
  res.end("Done.")
});

希望这有用。