使用 Hapi.js 进行日志记录-JavaScript中文网-JavaScript教程资源分享门户

在 Web 开发中，日志记录是一个重要的部分。它可以帮助我们跟踪应用程序的行为，及时发现潜在的问题，同时也是解决问题时的一个有力工具。针对日志记录，使用 Hapi.js 可以提供简单、灵活、高效的解决方案。

本文将介绍如何使用 Hapi.js 进行日志记录，包括 Hapi 的日志机制、设置与输出日志等内容。通过本文的学习，你将了解如何在 Hapi.js 中进行日志记录，以及如何应用这些知识来优化你的应用程序。

Hapi 的日志机制

Hapi.js 支持日志记录的机制，在任何一个请求生命周期内都可以记录。在处理请求时，Hapi 会记录所有有关请求和响应的数据，并将其记录在请求日志中。而且，你还可以通过添加新日志到服务器或管理上下文，来记录其他重要的事件。

由于 Node.js 中 stream 是处理数据的常见方式之一，因此我们可以在 Hapi.js 中将日志输出到不同的 stream 中，例如 stdout（标准输出）、stderr（标准错误输出）、文件或数据库。这让我们可以将不同的日志记录到不同的地方，以便快速定位和统计错误。

设置 Hapi 的日志配置

在 Hapi.js 的日志机制中，一个日志配置对象包含与特定日志相关的信息。以下是一个日志配置对象中可用的属性：

name：日志记录器的名称。在多个日志记录器存在的情况下，可以帮助我们区分不同的日志记录器。
level：日志记录器的等级。日志等级、也叫作日志事件类型（Event Type），可用于在记录过多的日志时过滤掉一些不必要的信息。日志等级可以是 info、error、debug 等。
stream：将日志记录到的流。可以是一个文件、一个网络 socket 或者一个可写流。这通常是最常用的输出目标。
path：记录日志文件的文件路径。

在 Hapi 中设置日志配置对象非常简单。我们使用 server.log 方法来记录一个日志事件，可以直接传入一个配置对象，就可以启用一个新的日志记录器。例如：

// javascriptcn.com 代码示例
const Hapi = require('hapi');
const server = Hapi.server({
  port: 3000,
  host: 'localhost'
});

const myLogger = server.log.bind(server, {
  name: 'myLogger',
  level: 'warn',
  stream: process.stderr
});

server.route({
  method: 'GET',
  path: '/',
  handler: (request, h) => {
    myLogger('this is a warning log');
    return 'Hello, world!';
  }
});

上述示例中，我们将一条警告级别的日志记录在 process.stderr，也就是标准错误输出中。注意，在这个例子中我们使用了 bind 方法来调用 server.log，以生成一个可重复使用的函数 myLogger。

输出 Hapi 的日志

对于我们在应用程序中定义的日志记录器，Hapi.js 有两种方式可以输出。

使用 server.logger() 方法我们使用 server.logger() 来创建一个知道系统的日志记录器。它会在系统的生存期内持续工作，无需手动维护日志。在创建服务器时，我们可以调用 server.logger() 方法，如下所示：

// javascriptcn.com 代码示例
const Hapi = require('hapi');
const server = Hapi.server({
  port: 3000,
  host: 'localhost',
  routes: {
    log: true
  }
});

console.log(server.logger);

在这个例子中，我们将 routes 设置为 log: true，然后在控制台上打印了 server.logger。启用后，我们可以在日志记录器中找到请求和响应的详细信息。如果需要在 API 中输出一些调试日志，可以使用 console_log: true 方法。

使用插件我们也可以使用插件来生成日志。Hapi 有很多插件可以帮助我们将数据输出到 Elasticsearch、Sentry、Loggly 等存储或错误处理服务。

一般地，我们可以从官方的 Hapi.js 插件目录中找到有用的插件，以达到记录日志和处理日志的目的。例如：

// javascriptcn.com 代码示例
const Hapi = require('hapi');
const Good = require('good');
const server = Hapi.server({
  port: 3000,
  host: 'localhost'
});

const loggerProvider = async function(event, tags) {
  const logger = server.logger;
  if (tags.error) {
    logger(['error', 'database'], event);
  } else {
    logger(['info', 'database'], event);
  }
}

const validateOptions = {
  opsInterval: 1000,
  reporters: {
    console: [
      {
        module: 'good-squeeze',
        name: 'Squeeze',
        args: [{log: '*', response: '*'}]
      },
      {
        module: 'good-console'
      },
      'stdout'
    ]
  }
};

await server.register({
  plugin: Good,
  options: validateOptions
});

在上述示例代码中，我们将 log 和 response 事件传递给 console 插件。这个地方使用了一个库叫作 good-squeeze 来压缩日志事件，它能够过滤出感兴趣的日志事件。good-console 库用于将日志写入控制台。

总结

本文介绍了如何在 Hapi.js 中进行日志记录，包括 Hapi 的日志机制、设置与输出日志等内容。通过本文的学习，你可以了解如何在 Hapi.js 中进行日志记录，以及如何应用这些知识来优化你的应用程序。如果你需要更多信息，请查阅 Hapi.js 官方文档。

参考资料

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/65376de67d4982a6ebff03d7