Node.js日志管理工具——ptkdev-logger使用教程

1. 项目介绍

ptkdev-logger 是一个为 Node.js 设计的日志管理工具，它提供了一个更好的替代方案来取代传统的 console.log 方法。这个工具易于使用，并且支持多种功能，比如日志的颜色定制、日志文件的轮转、TypeScript 支持，以及将日志输出到文件等。

2. 项目快速启动

首先，您需要在 Node.js 项目中安装 ptkdev-logger：

npm install @ptkdev/logger --save

然后，您可以在代码中这样使用它：

const Logger = require('@ptkdev/logger');
const logger = new Logger({
    language: 'zh', // 设置日志语言为中文
    colors: true, // 启用终端颜色
    debug: true, // 启用调试日志
    info: true, // 启用信息日志
    warning: true, // 启用警告日志
    error: true, // 启用错误日志
    sponsor: true, // 启用赞助商日志
    write: true, // 启用写入日志文件
    type: 'log', // 设置日志文件格式为文本
    path: { // 设置日志文件路径
        debug_log: './debug.log',
        error_log: './errors.log'
    }
});

logger.info('这是一条信息日志');

3. 应用案例和最佳实践

日志颜色定制

您可以通过设置 palette 选项来自定义日志的颜色：

const logger = new Logger({
    // 其他配置...
    palette: {
        info: {
            label: '#ffffff',
            text: '#4CAF50',
            background: '#4CAF50'
        },
        // 其他颜色配置...
    }
});

日志轮转

当日志文件达到一定大小时，您可以设置日志自动轮转：

const logger = new Logger({
    // 其他配置...
    rotate: {
        size: '10M',
        encoding: 'utf8'
    }
});

日志记录到文件

将日志记录到文件，便于后续分析和问题追踪：

const logger = new Logger({
    // 其他配置...
    write: true,
    type: 'json', // 使用JSON格式记录
    path: {
        debug_log: './debug.log',
        error_log: './errors.log'
    }
});

4. 典型生态项目

ptkdev-logger 可以与其他 Node.js 生态项目配合使用，例如：

• 与 express 框架结合，记录HTTP请求日志。
• 与 pm2 进程管理器一起工作，实现高效的日志管理。
• 结合 mocha 或 jest 测试框架，记录测试过程中的调试信息。

通过这些典型应用，ptkdev-logger 能够帮助开发者更好地监控和管理应用日志。