Nodejs Express日志记录插件express-pino-logger的使用

Nodejs Express日志记录插件express-pino-logger的使用
express-pino-logger 是一个用于在 Node.js Express 应用程序中集成 pino 日志记录库的中间件。它允许你方便地将请求日志和错误日志记录到控制台或文件中。下面是如何安装和配置 express-pino-logger 的步骤。

安装

首先，你需要安装 express-pino-logger 和 pino：

npm install express-pino-logger pino

使用

接下来，在你的 Express 应用程序中使用这个中间件。以下是一个简单的例子，展示了如何设置和使用 express-pino-logger：

示例代码

const express = require('express');
const pinoMiddleware = require('express-pino-logger');

// 创建一个 Express 应用
const app = express();

// 使用 express-pino-logger 中间件
app.use(pinoMiddleware());

// 定义一些路由
app.get('/', (req, res) => {
    res.send('Hello World!');
});

app.post('/submit', (req, res) => {
    res.status(201).send('Data received');
});

// 错误处理示例
app.use((err, req, res, next) => {
    console.error(err.stack);
    res.status(500).send('Something broke!');
});

// 启动服务器
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
    console.log(`Server is running on port ${PORT}`);
});

在这个例子中，我们创建了一个 Express 应用，并通过 app.use(pinoMiddleware()) 添加了 express-pino-logger 中间件。这将会为每个传入的 HTTP 请求生成日志条目，包括请求方法、URL、响应时间和状态码等信息。

高级配置

express-pino-logger 还支持许多高级配置选项，例如自定义日志格式、指定日志级别以及将日志输出到文件等。你可以通过传递一个配置对象来实现这些功能：

const express = require('express');
const pinoMiddleware = require('express-pino-logger');

const app = express();

app.use(pinoMiddleware({
    // 可以在这里添加配置选项
    logger: require('pino')({
        level: 'info',
        prettyPrint: true
    }),
    serializers: {
        res: (res) => ({
            statusCode: res.statusCode,
            headers: res._header
        })
    },
    autoLogging: {
        ignorePath: '/healthcheck'
    }
}));

// 路由和其他中间件...

在这个配置示例中，我们设置了日志级别为 info，启用了美化打印（仅在开发环境中有用），并自定义了响应对象的日志序列化方式。此外，我们还忽略了 /healthcheck 路径的日志记录。

通过这些步骤，你可以轻松地在你的 Express 应用程序中集成 express-pino-logger，从而获得详细的请求和错误日志。