如何为winston@3日志记录器创建自定义的json格式化程序？

Question

我正在尝试为winston v3制作自定义的JSON格式化程序。

以下是一个包含演示的单个文件：

const { createLogger, format, transports } = require("winston")
const { combine, timestamp, prettyPrint } = format

const logger = createLogger({
  format: combine(timestamp(), prettyPrint())
})

logger.add(new transports.Console())

logger.info("test message", { data: { a: 1, b: [1, 2, 3, 4], d: new Date() } })

try {
  throw new Error("I'm an error!")
} catch (err) {
  logger.error(err)
}

它打印出如下内容：

{ data: { a: 1, b: [ 1, 2, 3, 4 ], d: 2018-07-21T08:59:27.958Z },
  level: 'info',
  message: 'test message',
  timestamp: '2018-07-21T08:59:27.959Z',
  [Symbol(level)]: 'info',
  [Symbol(splat)]:
   [ { data: { a: 1, b: [ 1, 2, 3, 4 ], d: 2018-07-21T08:59:27.958Z } } ] }
{ Error: I'm an error!
    at Object.<anonymous> (/Users/max7z/projects/test/t32__test__winston__pretty-print_symbol/index.js:13:9)
    at Module._compile (internal/modules/cjs/loader.js:689:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
    at Module.load (internal/modules/cjs/loader.js:599:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
    at Function.Module._load (internal/modules/cjs/loader.js:530:3)
    at Function.Module.runMain (internal/modules/cjs/loader.js:742:12)
    at startup (internal/bootstrap/node.js:266:19)
    at bootstrapNodeJSCore (internal/bootstrap/node.js:596:3)
  level: 'error',
  timestamp: '2018-07-21T08:59:27.962Z',
  [Symbol(level)]: 'error' }

我希望您能提供几乎相同的输出，但不包括一些字段：[Symbol(level)]，[Symbol(splat)]。

是否可以从prettyPrint格式化程序中删除[Symbol]字段？

或者我该如何制作自己的自定义JSON格式化程序，以及像prettyPrint一样具有错误堆栈跟踪？

- Max Block

Answer 1

我使用winston v3.3.3进行了样本测试，并添加了一个自定义格式化程序来将data对象转换为字符串：

const winston = require('winston');

const myFormatter = winston.format((info) => {
  const {message} = info;

  if (info.data) {
    info.message = `${message} ${JSON.stringify(info.data)}`;
    delete info.data; // We added `data` to the message so we can delete it
  }
  
  return info;
})();

const logger = winston.createLogger({
  format: winston.format.combine(
    winston.format.timestamp({
      format: 'YYYY-MM-DD HH:mm:ss',
    }),
    myFormatter,
    winston.format.simple(),
  ),
  transports: [
    new winston.transports.Console(),
  ],
});

我跑了提问中的命令，并得到了期望的输出。

执行:

logger.info('test message', {data: {a: 1, b: [1, 2, 3, 4], d: new Date()}});

try {
  throw new Error(`I'm an error!`);
} catch (err) {
  logger.error(err);
}

输出：

信息：测试消息{"a":1,"b":[1,2,3,4],"d":"2020-09-09T09:41:22.525Z"}{"时间戳":"2020-09-09 11:41:22"}

错误：我是一个错误！{"时间戳":"2020-09-09 11:41:22"}

当使用winston.format.prettyPrint()而不是winston.format.simple()时，JSON对象也可以带有制表符和换行符的打印。

- Benny Code

---

在 combine 内部，应该是 myFormatter() 吧？ - Purefan

Answer 2

请查看如何创建自定义格式。 然后使用prettyPrint的源代码作为基础，根据您的需求创建一个修改版本。

Winstons使用triple-beam对各种Symbol进行定义，因此您也可以使用该程序包来删除它们。

- Lucas S.

---

你能否举个例子说明如何从“prettyPrint”输出中删除[Symbol]字段？我已经阅读了你的链接，但仍不知道如何实现。 - Max Block

您可以像删除其他字段一样使用 delete 命令来删除这些字段。 - Lucas S.

我同意@max7z的看法，文档非常令人困惑。虽然我没有使用splat，但我在一些console.debug调用中看到了splat，并且似乎无法以我想要的格式添加字段到输出中。作为最常用的记录器，这个东西真是让人困惑 :( - SomethingOn

Answer 3

最初的回答： 我遇到了类似的问题，并在这里找到了解决方案：https://github.com/winstonjs/winston/blob/master/examples/metadata.js。我正在使用 Node.js 和 Socket.IO，我在 Socket.IO 中使用了日志记录器。例如： Node.js

io.on('connection',function(socket){
  var date = new Date();
  socket.on('',function(data){
    logger.log('info', {IP: ip, Date: date, Path: '', Data: data.req_data});

Winston.js(logger)

const app_root = require('app-root-path');
const { createLogger, format, transports } = require('winston');


var logger = createLogger({
  level: 'info',
  format: format.combine(
    format(function(info, opts){
        console.log(`[${info.IP}]-[${info.Date}]-[${info.Path}]-[${info.Data}]`);
        return info;
    })(),
    format.json()

  ),

  transports: [
    new transports.File({filename: `${app_root}/logs/info.log`})
  ]
});

module.exports = logger;

据我所知，我们可以随意使用随机变量（如IP、日期、鸟、球等）。

我认为只需稍加调整，您也可以将其用于错误处理。祝好运！

最初的回答：

- PhiloSophia

Answer 4

参考 Winston格式。

require('winston-daily-rotate-file');
const { createLogger, format, transports } = require('winston');
const { combine, timestamp, label, printf, prettyPrint, splat, simple } = format;


const myFormat = printf(info => {
    // you can get splat attribue here as info[Symbol.for("splat")]
    // if you custome splat please rem splat() into createLogger()
    return `${info.timestamp} [${info.label}] ${info.level}: ${info.message}`;
});

const logger = createLogger({
  format: combine(
    label({ label: 'keaz.co' }),
    timestamp(),
    splat(),
    myFormat
  ),
  transports: [
      new transports.Console(),
      new transports.File({
        filename: "info.log",
        level: 'info'
      }),
      new transports.File({
        filename: "error.log",
        level: 'error'
      })
    ]
})

logger.info("test message %o", { data: { a: 1, b: [1, 2, 3, 4], d: new Date() } });

module.exports = logger;

- Tan Nguyen