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

Nodejs Express日志记录插件express-bunyan-logger的使用
express-bunyan-logger 是一个用于 Node.js Express 应用的日志记录中间件。它基于 bunyan 日志库，可以方便地配置和记录应用的各种日志信息。

以下是如何安装和使用 express-bunyan-logger 的步骤：

1. 安装

首先，你需要在你的项目中安装 express-bunyan-logger 和 bunyan：

npm install express-bunyan-logger bunyan --save

2. 配置和使用

下面是一个简单的例子，展示如何将 express-bunyan-logger 添加到 Express 应用中：

const express = require('express');
const createLogger = require('express-bunyan-logger');

const app = express();

// 创建日志记录器
const logger = createLogger({
    logName: 'my-app',
    streams: [
        // 控制台输出
        {stream: process.stdout},
        // 文件输出
        {path: './logs/my-app.log'}
    ],
    level: 'info', // 设置日志级别
    parseUA: true, // 解析用户代理字符串
    parseReqBody: true, // 解析请求体
});

// 使用日志中间件
app.use(logger);

// 示例路由
app.get('/', (req, res) => {
    res.send('Hello World!');
});

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

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

3. 自定义日志格式

你还可以自定义日志的格式，例如：

const logger = createLogger({
    logName: 'my-app',
    serializers: {
        req: (req) => ({
            method: req.method,
            url: req.url,
            headers: req.headers,
            params: req.params,
            query: req.query,
            body: req.body,
        }),
        res: (res) => ({
            statusCode: res.statusCode,
        })
    },
    streams: [
        {stream: process.stdout}
    ]
});

在这个例子中，我们为请求和响应对象定义了自定义序列化函数，以便更好地控制记录的信息。

4. 记录错误

当发生错误时，你可以通过调用 logger.error() 来记录错误信息。你也可以在错误处理中间件中使用它来记录错误：

app.use((err, req, res, next) => {
    logger.error({ err }, 'An error occurred');
    res.status(500).send('Something broke!');
});

这样，你就可以开始使用 express-bunyan-logger 在你的 Express 应用中记录详细的日志信息了。


3 回复

当然，让我们用点幽默来聊聊express-bunyan-logger！

想象一下，你的Node.js应用是一个超级英雄，而Express就是那个给了他超能力的导师。但是，每个超级英雄都需要一个可靠的伙伴来记录他们的英勇事迹，对吧？这就轮到express-bunyan-logger登场了！

首先，你需要安装这位“记录者”：

npm install express-bunyan-logger --save

然后，在你的Express应用中，给它一个舞台：

const bunyan = require('bunyan');
const createLogger = require('express-bunyan-logger');

const app = express();

app.use(createLogger({
    logName: 'MySuperHeroApp',
    level: 'info', // 你可以根据需要调整级别
    skip: function (req, res) { return res.statusCode < 400 }, // 只记录错误或更糟的情况？
}));

现在，每次你的应用执行时，express-bunyan-logger都会默默地记录下一切，就像一位隐身的守护者。这样，当你的超级英雄应用遇到麻烦时（比如状态码大于等于400），你就能快速找到问题所在，而不是像无头苍蝇一样乱撞。

希望这能帮你更好地理解和使用express-bunyan-logger！


express-bunyan-logger 是一个 Node.js 应用程序中用于集成 Bunyan 日志系统的中间件。Bunyan 是一个简单的基于流的日志库，其输出是易于机器解析的 JSON 格式。下面是如何在 Express 应用程序中使用 express-bunyan-logger 的步骤和示例代码。

安装

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

npm install express-bunyan-logger bunyan

使用

  1. 引入必要的模块： 需要引入 express、express-bunyan-logger 和 bunyan 模块。

  2. 创建一个日志配置对象： 这个对象定义了日志的基本信息，如名称、版本等。

  3. 初始化 express-bunyan-logger 中间件： 将这个中间件添加到 Express 应用程序中。

  4. 创建 Express 应用程序并使用中间件： 创建 Express 应用，并将日志中间件添加进去。

示例代码

const express = require('express');
const createLogger = require('express-bunyan-logger');

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

// 创建日志配置对象
const logConfig = {
  streams: [
    // 将日志输出到控制台
    { stream: process.stdout },
    // 可以添加更多输出流，比如文件流
    // { path: 'mylogfile.log' }
  ],
  // 日志级别，默认是 info
  level: 'debug',
  // 附加字段
  additionalFields: {
    application: 'myApp'
  }
};

// 初始化日志中间件
app.use(createLogger(logConfig));

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

// 启动服务器
app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

在这个例子中，我们创建了一个简单的 Express 应用程序，并通过 createLogger 函数设置了一个日志中间件。所有的请求都会被记录下来，包括请求的时间、URL、状态码等信息。这些日志会同时输出到控制台以及可选的日志文件中。

注意，你可以根据需要调整日志级别 (level) 和其他配置选项，来控制哪些级别的日志会被记录以及它们如何被输出。

express-bunyan-logger 是一个用于 Node.js 的 Express 应用的日志记录中间件，基于 Bunyan。首先安装该插件：

npm install express-bunyan-logger

使用示例：

const express = require('express');
const createLogger = require('express-bunyan-logger');

const app = express();

app.use(createLogger({
  logName: 'MyApp',
  accessLogPath: './access.log',
  errorLogPath: './error.log'
}));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000);

此配置会在当前目录下生成 access.log 和 error.log 文件，分别记录访问日志和错误日志。

回到顶部