Winston 日志记录对象

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

如果您希望将对象记录到控制台和文件中，您可以执行以下操作：

1.初始化2种格式。一个用于文件，另一个用于控制台。注意consoleFormat中使用的JSON.stringify方法

const winston = require("winston");
const { format, transports, createLogger } = winston;
const path = require("path");
const consoleloggerLevel = process.env.WINSTON_LOGGER_LEVEL || "info";

const consoleFormat = format.combine(
  format.colorize(),
  format.timestamp(),
  format.align(),
  format.printf((info) => {
    return `${info.timestamp} - ${info.level}:  [${info.label}]: ${
      info.message
    } ${JSON.stringify(info.metadata)}`;
  })
);

const fileFormat = format.combine(
  format.timestamp(),
  format.label({ label: path.basename(process.mainModule.filename) }),
  format.metadata({ fillExcept: ["message", "level", "timestamp", "label"] }),
  format.json()
);

2.现在，创建记录器。

const logger = createLogger({
  level: "info",
  defaultMeta: { service: "some-random-service" },
  format: fileFormat,
  transports: [
    new transports.File({
      filename: path.join(__dirname, "../logs/error.log"),
      level: "error",
    }),
    new transports.File({
      filename: path.join(__dirname, "../logs/activity.log"),
      maxsize: 5242880, //5MB
      maxFiles: 5 // just in case  
    }),
  ],
});

3.仅在非生产环境中启用控制台日志记录：

if (process.env.NODE_ENV !== "production") {
  logger.add(
    new transports.Console({
      level: consoleloggerLevel,
      format: consoleFormat,
    })
  );
}

4.将其导出为默认记录器

module.exports = logger;

开启logger.info("Server started listening", { port: 9000 } );

这将打印出来，

在控制台上：

2021-06-22T07:47:25.988Z - info:  [index.js]:   Server started listening {"service":"some-random-service", "port": 9000}

在文件中：

{"message":"Server started listening","level":"info","timestamp":"2021-06-22T07:47:25.988Z","label":"index.js","metadata":{"service":"some-random-service", "port": 9000}}

Answer 2

您正在尝试将 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

日志文件输出（手工美化，参见传输文件格式的注释）：

{
  message: 'Register Daniel Duuch with email daniel.duuch@greatmail.com',
  level: 'debug',
  timestamp: '2019-05-11 17:05:45',
  label: 'index.js',
  metadata: {
    name: 'Daniel Duuch',
    email: 'daniel.duuch@greatmail.com',
    password: 'myGreatPassword',
    action: 'register'
  }
}

希望这能解决您的问题。

Code for this answer

Answer 3

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

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 4

或者你只是使用

打印

函数与 JSON.stringify

结合使用

new winston.transports.Console({
  format: winston.format.combine(
    winston.format.colorize(),
    winston.format.simple(),
    winston.format.printf(context => {
      const msgstr = JSON.stringify(context.message, null, '\t')
      return `[${context.level}]${msgstr}`
    }),
  ),
})

Answer 5

我不得不结合@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 应该使用此设置记录您的对象。

Answer 6

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

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

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

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