npm 包 @types/pino 使用教程

前言

在开发前端应用的过程中，我们常常需要使用日志记录工具来记录应用的运行状态，以帮助我们更好地调试和定位问题。而 pino 就是目前比较受欢迎的一个 Node.js 日志工具。其具有高性能、低内存占用、可定制化等优点，以及丰富的插件和扩展包支持。

本文将介绍 npm 包 @types/pino 的使用方法，以帮助读者更好地使用这一工具。

安装

@types/pino 是一个 TypeScript 类型定义文件包，用于在 TypeScript 代码中使用 pino。因此，在使用该包之前，必须先对 pino 进行安装。

通过 npm 安装 pino：

npm install pino

如果需要使用 pino 的额外扩展包，也可以直接安装这些扩展包，例如 pino-pretty：

npm install pino-pretty

安装完成后，可以通过以下代码进行测试：

const pino = require('pino')();

pino.info('hello world');

这将输出以下信息：

{"pid":35187,"hostname":"democode","level":30,"msg":"hello world","time":1638737675315,"v":1}

接着，需要安装 @types/pino：

npm install -D @types/pino

使用

在使用 @types/pino 之前，需要在 TypeScript 代码中引入 pino。

import * as pino from 'pino';

在默认情况下，pino 会输出 JSON 格式的日志，不太容易阅读。因此，可以通过 pino-pretty 或自定义输出格式来打印更易读的日志。

定制输出格式

下面是一个定义了自定义输出格式的示例：

-- -------------------- ---- -------
------ - -- ---- ---- -------

----- ------ - -------------
    ---------- ----- ---- -------- ---- -- -
        ------ ------------ ------------------- --------------
    -
---

----------------------------

----- ------ - ------
    ------ ------
-- --------

------------------ --------

这将输出以下信息：

2021-12-06T08:54:53.349Z [info] hello world

使用扩展包 pino-pretty

下面是一个使用 pino-pretty 打印漂亮日志的示例：

import * as pino from 'pino';
import * as pinoPretty from 'pino-pretty';

const logger = pino({
    level: 'info'
}, pinoPretty());

logger.info('hello world');

这将输出以下信息：

[2021-12-06T08:54:53.349Z] INFO (35187 on democode): hello world

使用环境变量设置日志级别

pino 支持使用环境变量来设置日志级别。例如，可以在 .env 文件中设置 LOG_LEVEL 环境变量：

LOG_LEVEL=info

接着，在代码中，可以通过以下方式获取 LOG_LEVEL 的值，并传递给 pino：

const pinoLevel = process.env.LOG_LEVEL || 'info';

const logger = pino({
    level: pinoLevel
}, pinoPretty());

结语

本文介绍了 npm 包 @types/pino 的安装和使用方法。同时，也给出了一些实用的示例代码，希望读者可以通过本文更好地使用 pino 来记录应用的运行状态。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/199601