Pino-Pretty使用手册

Pino-Pretty使用手册

pino-pretty 🌲Basic prettifier for Pino log lines 项目地址: https://gitcode.com/gh_mirrors/pi/pino-pretty

Pino-Pretty是一款专为Pino日志库设计的美化工具，它在开发环境下将原始的日志数据转换为更加易读的格式。本篇文档将引导您完成安装、基本使用以及配置API的过程，确保您能够充分利用Pino-Pretty的功能。

安装指南

为了在您的项目中使用Pino-Pretty，只需通过npm执行以下命令进行全局安装：

$ npm install -g pino-pretty

若只希望在开发环境中使用，推荐将其作为开发依赖添加：

$ npm install --save-dev pino-pretty

项目使用说明

命令行使用

在应用运行时，通过管道操作将Pino日志导向Pino-Pretty即可立即生效。例如，如果您有一个名为app.js的程序生成Pino日志：

node app.js | pino-pretty

程序内集成

在开发阶段，也可以直接在代码中集成Pino-Pretty，以更灵活地控制日志输出：

const pino = require('pino');
const prettyStream = require('pino-pretty');

// 使用Pino-Pretty作为日志的传输目标
const logger = pino({
  transport: {
    target: 'pino-pretty',
    options: {
      colorize: true, // 开启颜色支持
    },
  },
});

logger.info('Hello, world!');

或者作为流处理：

const stream = prettyStream({
  colorize: true,
});
const logger = pino(stream);
logger.info('Another info message.');

API使用文档

Pino-Pretty提供了丰富的CLI参数及选项来定制输出风格，以下是一些常用设置：

• colorize (-c): 开启终端颜色。
• timestampKey (-a): 自定义时间戳键名，默认为time。
• translateTime (-t): 将时间戳转换成可读格式，如HH:MM:ss.l。
• minimumLevel (-L): 设置最低日志级别，低于此级别的消息不会显示。
• messageFormat (-o): 定制消息输出格式，如{levelLabel} - {pid}。

完整选项列表与说明可在命令行帮助或官方文档中找到。

项目安装方式

上述已涵盖Pino-Pretty的基本安装方法，无论是全局安装以便于命令行直接调用，还是作为开发依赖项集成到项目中，都是通过npm管理工具实现的。

记得，正确配置您的日志输出，并利用Pino-Pretty的强大功能提升开发过程中的日志阅读体验。

pino-pretty 🌲Basic prettifier for Pino log lines 项目地址: https://gitcode.com/gh_mirrors/pi/pino-pretty