在Ubuntu环境中为Node.js应用配置日志格式,虽然看似简单,但正确的设置能极大简化问题排查与性能监控流程。以下介绍几种主流且高效的日志配置方案,你可根据项目需求及团队偏好灵活选用。
方法一:借助 morgan 中间件(Express 应用首选方案)
对于基于 Express 框架构建的应用,morgan 堪称标配工具——它轻量级、即装即用,并支持高度自定义的日志输出格式。
第一步:安装 morgan 包
npm install morgan
第二步:在应用中配置日志格式
const express = require('express');
const morgan = require('morgan');
const app = express();
// 自定义 token,定义所需的日志输出样式
morgan.token('customFormat', function (req, res) {
return `${req.method} ${req.url} - ${res.statusCode} ${req.responseTime}ms`;
});
// 将自定义格式挂载到中间件
app.use(morgan('customFormat'));
// 后续路由正常编写
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(3000, () => {
console.log('Server is running on port 3000');
});
经过以上配置,每个请求完成后控制台将输出如 GET / - 200 12ms 的清晰记录,极大便利调试工作。
方法二:使用 winston 日志库(功能全面,适用场景广泛)
当应用复杂度提升,需要同时向控制台、文件甚至远程日志服务输出不同级别的日志时,winston 是更合适的选择。它支持多种传输通道与灵活的格式自定义。
安装:
npm install winston
配置一个带时间戳的 logger:
const winston = require('winston');
const logger = winston.createLogger({
level: 'info', // 仅记录 info 及以上级别
format: winston.format.combine(
winston.format.timestamp(), // 自动添加时间戳
winston.format.printf(({ timestamp, level, message }) => {
return `${timestamp} ${level}: ${message}`;
})
),
transports: [
new winston.transports.Console(), // 输出到控制台
new winston.transports.File({ filename: 'error.log', level: 'error' }), // 将错误单独记录到文件
new winston.transports.File({ filename: 'combined.log' }) // 所有日志汇总
]
});
// 使用 logger 记录日志
logger.info('Hello World!');
logger.error('Something went wrong');
如此配置后,终端与日志文件将获得结构化且带时间戳的信息,便于后续使用 grep 或日志分析工具进行处理。
方法三:通过环境变量动态切换日志格式
同一项目可能同时运行于开发、测试、生产环境,不同环境对日志格式的要求各异。通过环境变量控制格式,无需修改代码即可灵活调整。
首先定义环境变量:
export LOG_FORMAT='[:method] [:url] - [:status] :responseTime ms'
然后在代码中读取该变量:
const express = require('express');
const morgan = require('morgan');
const app = express();
const logFormat = process.env.LOG_FORMAT || ':method :url - :status :responseTime ms';
app.use(morgan(logFormat));
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(3000, () => {
console.log('Server is running on port 3000');
});
这样一来,开发环境可使用包含毫秒的详细格式,生产环境则可切换为简洁的 combined 格式,完全无需改动代码。
总结:morgan 适合 Express 项目的快速落地,winston 适用于多目标、多级别的复杂日志场景,而环境变量配置法能让不同部署环境之间灵活切换。请根据项目阶段与运维需求,选择最合适的日志格式方案。
