Debian下JS日志记录有哪些注意事项

Debian下JS日志记录注意事项

1. 选择合适的日志库

根据应用场景选择功能匹配的日志库：

Winston：功能全面，支持多传输（文件、控制台、HTTP等）、灵活格式化（JSON、文本），适合需要高度定制化的应用；
Pino：以高性能、低开销著称（比Winston快2-3倍），适合高并发、大规模生产环境；
Morgan：专为Express.js设计，提供HTTP请求日志的灵活格式化（如 combined、common 格式）；
Log4js：支持日志级别控制、文件轮换、syslog输出，适合传统企业级应用。
示例（Winston配置）：

const winston = require('winston');
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});
if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({ format: winston.format.simple() }));
}

2. 合理设置日志级别

根据环境调整日志级别，避免不必要的性能消耗：

开发环境：使用debug级别，记录详细调试信息（如变量值、函数调用栈）；
测试环境：使用info或warn级别，记录关键流程和潜在问题；
生产环境：使用error或warn级别，仅记录错误和警告，减少日志体积。
示例（环境变量控制）：

const level = process.env.NODE_ENV === 'production' ? 'warn' : 'debug';
const logger = winston.createLogger({ level, format: winston.format.json() });

3. 实现日志轮转

防止日志文件过大占用磁盘空间，推荐使用以下工具：

Winston插件：winston-daily-rotate-file，支持按日期轮换（如app-2025-10-16.log），并自动压缩旧日志；
系统工具：logrotate，通过配置文件（如/etc/logrotate.d/my-js-app）实现按大小（如10M）或日期轮换，支持保留指定数量（如7天）的日志。
示例（winston-daily-rotate-file配置）：

const DailyRotateFile = require('winston-daily-rotate-file');
const logger = winston.createLogger({
  transports: [
    new DailyRotateFile({
      filename: 'application-%DATE%.log',
      datePattern: 'YYYY-MM-DD',
      zippedArchive: true,
      maxSize: '20m',
      maxFiles: '14d'
    })
  ]
});

4. 强化安全性

避免敏感信息泄露，保护日志数据的完整性和保密性：

敏感数据脱敏：使用sanitize-error等库过滤日志中的密码、密钥、个人身份信息（PII）；
权限控制：将日志文件目录权限设置为640（属主可读写，组可读），属主为root或应用专用用户（如appuser）；
传输加密：若将日志发送到远程服务器（如ELK Stack），使用TLS/SSL加密传输通道；
日志审计：定期检查日志文件，监控异常访问（如大量ERROR日志）或未授权修改。
示例（敏感信息过滤）：

const sanitize = require('sanitize-error');
logger.error('Database connection failed', sanitize(error));

5. 优化性能

避免日志记录成为应用瓶颈：

异步日志记录：大多数日志库（如Winston、Pino）默认支持异步写入，确保日志操作不阻塞主线程；
合理控制日志量：避免在循环或高频函数中记录debug日志，使用条件判断（如if (logger.isDebugEnabled())）减少不必要的日志输出；
选择高性能库：生产环境优先使用Pino（比Winston快2-3倍），尤其适合高并发场景。
示例（Pino异步记录）：

const pino = require('pino');
const logger = pino({ level: 'info' }, pino.destination('app.log')); // 异步写入

6. 统一日志格式

采用结构化格式（如JSON）便于后续解析和分析：

字段要求：包含时间戳（ISO 8601格式）、日志级别（info/error等）、进程ID、模块名、日志信息和上下文（如请求ID、用户ID）；
工具支持：使用winston.format.json()（Winston）或Pino的默认JSON格式，方便与ELK Stack、Graylog等工具集成。
示例（结构化日志）：

{
  "timestamp": "2025-10-16T12:34:56.789Z",
  "level": "error",
  "pid": 1234,
  "module": "auth",
  "message": "Failed login attempt",
  "context": { "userId": "admin", "ip": "192.168.1.1" }
}

7. 集中管理与监控

实现日志的统一收集和分析，提升问题排查效率：

集中式日志管理：使用ELK Stack（Elasticsearch+Logstash+Kibana）、Graylog或Fluentd，将分散的日志集中存储、搜索和可视化；
实时监控与报警：通过Prometheus+Grafana监控日志指标（如错误率、日志量突增），设置报警规则（如ERROR日志超过10条/分钟时发送邮件或短信通知）。
示例（PM2日志管理）：

# 安装pm2和pm2-logrotate
npm install pm2 -g
pm2 install pm2-logrotate

# 配置pm2-logrotate（保留7天日志，压缩）
pm2 set pm2-logrotate:retain 7
pm2 set pm2-logrotate:compress true

8. 环境适配

根据不同环境（开发、测试、生产）调整日志配置：

开发环境：输出到控制台（Console transport），使用simple格式（易读），开启debug级别；
生产环境：输出到文件（File transport），使用JSON格式，开启warn或error级别，启用日志轮转和集中管理。
示例（环境变量配置）：

const isProduction = process.env.NODE_ENV === 'production';
const transports = [];
if (isProduction) {
  transports.push(new winston.transports.File({ filename: 'error.log', level: 'error' }));
  transports.push(new winston.transports.File({ filename: 'combined.log' }));
} else {
  transports.push(new winston.transports.Console({ format: winston.format.simple() }));
}
const logger = winston.createLogger({ level: isProduction ? 'warn' : 'debug', transports });

1. 选择合适的日志库

2. 合理设置日志级别

3. 实现日志轮转

4. 强化安全性

5. 优化性能

6. 统一日志格式

7. 集中管理与监控

8. 环境适配

最新问答

相关标签