温斯顿日志对象

Question

我使用 Winston 进行后端日志记录我无法在不使用的情况下记录对象，JSON.stringify这很烦人

logger.debug(`Register ${JSON.stringify(req.body)}`)

const logger: Logger = createLogger({
    // change level if in dev environment versus production
    level: env === 'production' ? 'info' : 'debug',
    format: format.combine(
        format.label({label: path.basename(process.mainModule.filename)}),
        format.timestamp({format: 'YYYY-MM-DD HH:mm:ss'}),
        format.prettyPrint()
    ),
    transports: [
        new transports.Console({
            format: format.combine(format.colorize(), logFormat),
        }),
        new transports.File({
            filename,
            format: format.combine(format.json()),
        }),
    ],
    exitOnError: false,
})

你能告诉我用 Winston 记录对象的方法吗？我使用的是 3.2.1 版

Answer 1

您正在尝试将 JSON 对象直接插入字符串中，因此它将在[Object Object]没有JSON.stringify.

这不能通过配置 Winston 来解决，因为在生成字符串时（在logger.debug函数实际读取它之前）会发生此问题，因此console.log调用将打印相同的内容。

logger.*函数的第一个参数是消息（字符串），然后你可以传递一个元数据对象（JSON）。

要在logFormat函数中使用元数据，请按如下方式更新 Logger 实例：

const winston = require('winston')
const { format, transports } = winston
const path = require('path')

const logFormat = format.printf(info => `${info.timestamp} ${info.level} [${info.label}]: ${info.message}`)

const logger = winston.createLogger({
  level: process.env.NODE_ENV === 'production' ? 'info' : 'debug',
  format: format.combine(
    format.label({ label: path.basename(process.mainModule.filename) }),
    format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
    // Format the metadata object
    format.metadata({ fillExcept: ['message', 'level', 'timestamp', 'label'] })
  ),
  transports: [
    new transports.Console({
      format: format.combine(
        format.colorize(),
        logFormat
      )
    }),
    new transports.File({
      filename: 'logs/combined.log',
      format: format.combine(
        // Render in one line in your log file.
        // If you use prettyPrint() here it will be really
        // difficult to exploit your logs files afterwards.
        format.json()
      )
    })
  ],
  exitOnError: false
})

用法：

const req = {
  body: {
    name: 'Daniel Duuch',
    email: 'daniel.duuch@greatmail.com',
    password: 'myGreatPassword'
  }
}

logger.debug(`Register ${req.body.name} with email ${req.body.email}`, { ...req.body, action: 'register' })

控制台输出：

2019-05-11 17:05:45 debug [index.js]: Register Daniel Duuch with email daniel.duuch@greatmail.com

日志文件输出（手动美化，请参阅传输文件格式中的注释）：

2019-05-11 17:05:45 debug [index.js]: Register Daniel Duuch with email daniel.duuch@greatmail.com

希望这能解决您的问题。

此答案的代码

Answer 2

我的解决方案是使用这种格式化程序：

const { format } = winston
const consoleFormat = format.combine(
  format.prettyPrint(),
  format.splat(),
  format.printf((info) => {
    if (typeof info.message === 'object') {
      info.message = JSON.stringify(info.message, null, 3)
    }

    return info.message
  })
)

现在所有这些选项都按预期工作：

logger.info('plain text')
logger.info('plain text with object %o', { a:1, b: 2} )
logger.info({ a:1, b: 2 })

Answer 3

您可以format.splat()在记录器配置中使用：

const logger = createLogger({
    format: combine(
        ...
        format.splat(), // <--
        ...
    ),
    ...
});

...并使用字符串插值记录对象：

let myObj = { /* ... */ };
logger.info('This message will include a complete object: %O', myObj);

Answer 4

我不得不结合@SherloxFR 和@Anton 提供的解决方案。

const Winston = require('winston');
const { format } = Winston;

const options = {
    file: {
        ....
        format: format.combine(
            format.splat(), 
            format.json()
        ),
        ...
    },
    console: {
        ...
        format: format.combine(
            format.splat(),
            format.json()
        ),
        ...
    }
};

您可以看到我在上面的代码中将format.splat()和都添加format.json()到了选项配置中。

const logger = new Winston.createLogger({
    transports: [
        new Winston.transports.File(options.file),
        new Winston.transports.Console(options.console)
    ],
    exitOnError: false // do not exit on handled exceptions
});

这就是我使用选项配置对象的方式。您实际上可以在传输数组中编写格式代码，但我不喜欢那样。反正都是你的选择。

像这样配置后，这就是我在代码中使用它的方式

let myObj = {
   name: "StackOverflow",
};

logger.info('Content: %o', myObj);

如果你愿意，你也可以像这样传播它

logger.info('Content: %o', {...myObj});

就这样。Winston 应该使用此设置记录您的对象。