如何自定义Node.js Debian日志格式

要自定义 Node.js 应用程序在 Debian 系统上的日志格式，可以采用多种方法。以下介绍几种常用的方法，包括使用 winston 日志库、配置 pm2 的日志格式以及使用 Node.js 内置的 console 模块。根据您的具体需求和应用场景选择合适的方法。

方法一：使用 Winston 日志库自定义日志格式

winston 是一个功能强大的 Node.js 日志库，支持多种传输方式和自定义日志格式。以下是如何使用 winston 自定义日志格式的步骤：

安装 Winston
```
npm install winston
```

创建自定义格式

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

// 定义自定义格式
const myFormat = format.combine(
  format.timestamp({
    format: 'YYYY-MM-DD HH:mm:ss'
  }),
  format.printf(({ timestamp, level, message }) => {
    return `[${timestamp}] [${level.toUpperCase()}]: ${message}`;
  })
);

// 创建 logger 实例
const logger = createLogger({
  level: 'info',
  format: myFormat,
  transports: [
    new transports.Console(),
    // 可以添加更多传输方式，如文件、HTTP 等
    // new transports.File({ filename: 'app.log' })
  ]
});

// 使用 logger
logger.info('这是一条信息日志');
logger.error('这是一条错误日志');

运行应用程序

运行您的 Node.js 应用程序，日志将以自定义的格式输出到控制台或指定的传输方式中。

方法二：使用 PM2 配置日志格式

如果您使用 pm2 来管理 Node.js 应用程序，可以通过配置文件或命令行参数来自定义日志格式。

使用 ecosystem.config.js 配置

创建或编辑 ecosystem.config.js 文件，添加 log_format 配置项：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: './app.js',
      instances: 'max',
      exec_mode: 'cluster',
      log_date_format: 'YYYY-MM-DD HH:mm:ss', // 日志日期格式
      out_file: './logs/out.log', // 标准输出日志文件
      error_file: './logs/err.log', // 错误日志文件
      merge_logs: true, // 合并日志
      log_level: 'info', // 日志级别
      // 自定义日志格式（需要使用自定义传输或工具）
    },
  ],
};

注意：pm2 默认不支持复杂的自定义格式，但可以通过自定义传输或结合其他工具实现。

使用命令行参数

某些 pm2 命令支持日志相关的参数，但自定义格式有限。例如：
```
pm2 start app.js --name my-app --log-date-format "YYYY-MM-DD HH:mm:ss"
```

方法三：使用 Node.js 内置的 `console` 模块自定义格式

如果不需要复杂的日志管理，可以使用 Node.js 内置的 console 模块结合第三方库来格式化日志。

安装 chalk 和 moment
```
npm install chalk moment
```

创建自定义日志函数

const chalk = require('chalk');
const moment = require('moment');

function log(level, message) {
  const timestamp = moment().format('YYYY-MM-DD HH:mm:ss');
  const color = {
    info: chalk.blue,
    warn: chalk.yellow,
    error: chalk.red,
  }[level] || chalk.white;

  console.log(`${color(timestamp)} [${level.toUpperCase()}]: ${chalk.white(message)}`);
}

// 使用自定义日志函数
log('info', '这是一条信息日志');
log('error', '这是一条错误日志');

方法四：使用 `morgan` 中间件自定义 HTTP 日志格式（适用于 Express 应用）

如果您使用的是 Express 框架，可以使用 morgan 中间件来自定义 HTTP 请求日志格式。

安装 Morgan
```
npm install morgan
```

配置自定义日志格式

const express = require('express');
const morgan = require('morgan');

const app = express();

// 自定义 Morgan 格式
morgan.token('customFormat', function (req, res) {
  return `${moment().format('YYYY-MM-DD HH:mm:ss')} | ${req.method} ${req.url} ${res.statusCode}`;
});

app.use(morgan('customFormat'));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

方法五：配置系统日志（如 `syslog`）

如果希望将 Node.js 应用程序的日志发送到系统的日志服务（如 rsyslog），可以使用第三方库如 winston-syslog。

安装 winston-syslog
```
npm install winston-syslog
```

配置 Winston 使用 Syslog

const { createLogger, format } = require('winston');
const Syslog = require('winston-syslog').Syslog;

const logger = createLogger({
  level: 'info',
  format: format.combine(
    format.timestamp(),
    format.printf(({ timestamp, level, message }) => {
      return `[${timestamp}] [${level.toUpperCase()}]: ${message}`;
    })
  ),
  transports: [
    new Syslog({
      host: 'localhost',
      port: 514,
      protocol: 'udp4',
      app_name: 'my-node-app',
      eol: '\n',
    }),
  ],
});

logger.info('这是一条发送到 syslog 的日志');

注意：确保系统的 syslog 服务已正确配置并运行。

总结

根据您的需求，可以选择适合的方法来自定义 Node.js 应用程序在 Debian 系统上的日志格式：

简单格式化：使用 Node.js 内置的 console 模块结合第三方库（如 chalk、moment）。
复杂日志管理：使用 winston 等专业的日志库，支持多种传输方式和高度自定义的日志格式。
生产环境部署：结合 pm2 进行进程管理和日志监控，必要时通过自定义传输或系统日志集成实现更复杂的日志格式。

通过合理配置和使用这些工具，您可以有效地管理和自定义 Node.js 应用程序的日志输出，提升日志的可读性和可维护性。

亿速云「云服务器」，即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘，价格低至29元/月。点击查看>>

0 赞

0 踩

方法一：使用 Winston 日志库自定义日志格式

方法二：使用 PM2 配置日志格式

方法三：使用 Node.js 内置的 console 模块自定义格式

方法四：使用 morgan 中间件自定义 HTTP 日志格式（适用于 Express 应用）

方法五：配置系统日志（如 syslog）

总结

方法三：使用 Node.js 内置的 `console` 模块自定义格式

方法四：使用 `morgan` 中间件自定义 HTTP 日志格式（适用于 Express 应用）

方法五：配置系统日志（如 `syslog`）