在winston日志条目中添加模块名称

Question

是否有可能保存当前模块名称,以便在以后调用winston日志条目时自动打印？

目前,当我想在日志中打印模块名称时,我必须手动添加它:

var logHeader = 'mymodule'

log.info(logHeader + 'Hello')

例如,使用debug,您可以执行(暂时忽略日志格式功能%s):

var debug = require('debug')('http')
  , name = 'My App'

debug('booting %s', name);

这将http在日志之前为prin 前缀:

http启动我的应用程序

这可以在温斯顿完成吗？我在文档中搜索过,但找不到任何相关内容.

Answer 1

我找到了一个更好的方法来做到这一点.

我在winston记录器上添加了一个额外的层,在本例中是一个函数,它保留了需要记录器的每个模块的模块名称.所以当一个模块require是我的新记录器时,它实际上用模块名称调用导出的函数,在这种情况下__filename.

log.js

var winston = require('winston')

var winstonLogger = new (winston.Logger)({
    transports: [
        new (winston.transports.File) ({
            filename: 'MyLogs.txt',
            handleExceptions: true,
            humanReadableUnhandledException: true,
            level: 'info',
            timestamp: true,
            json: false
        }),
        new (winston.transports.Console) ({
            level: 'info',
            prettyPrint: true,
            colorize: true,
            timestamp: true
        })
    ]
})

module.exports = function(fileName) {    
    var myLogger = {
        error: function(text) {
            winstonLogger.error(fileName + ': ' + text)
        },
        info: function(text) {
            winstonLogger.info(fileName + ': ' + text)
        }
    }

    return myLogger
}

module1.js

var log = require('log')(__filename)

log.info('Info log example')

info:C:\ Users\user1\project\module1.js:信息日志示例

module2.js

var log = require('log')(__filename)

log.error('Error log example')

错误:C:\ Users\user1\project\module2.js:错误日志示例

而且,这样,我不需要改变我提交文本日志的方式; log.info('text')和以前一样.

Answer 2

这就是子记录器的用途。当提出这个问题时，它们可能不可用，但为了将来参考，您可以创建主记录器实例，然后导出一个函数，该函数使用一些默认选项创建子记录器。

// logging.js
const winston = require('winston') 

const logger = winston.createLogger({
  transports: [
    new winston.transports.Console({
      format: winston.format.printf(options => {
        // you can pass any custom variable in options by calling
        // logger.log({level: 'debug', message: 'hi', moduleName: 'my_module' })
        return `[${options.moduleName}] ${options.level}: ${options.message}$`;
      })
    })
  ]
});

module.exports = function(name) {
  // set the default moduleName of the child
  return logger.child({moduleName: name});
}

然后在每个模块的顶部，使用以下命令导入子项：

// my_module.js
const logger = require('./logging.js')('my_module_name');

logger.error('computer says no');
// output:
// [my_module_name] error: computer says no