在 Web 开发过程中，日志管理是一个不可忽视的重要部分。通过记录程序运行时的各种信息，我们可以更好地了解代码的运行状况，及时定位问题，从而优化代码并提升系统可靠性。Hapi.js 是一个流行的 Node.js Web 开发框架，它提供了多种日志管理方法。本文将介绍使用 good 进行日志管理的实际操作过程，为您提供完整的指导。
Good 是什么？
Good 是一个基于 Hapi.js 的插件，用于日志记录和监控。它可以轻松地将不同来源的数据输出到不同的目标，如控制台、文件和 Elasticsearch 等。Good 的优点是易用性和灵活性，可以满足各种不同场景的需求。
使用 Good 进行日志记录
Good 至少需要三个插件：good, good-squeeze 和 good-console，分别用于提供日志收集功能、筛选和压缩日志数据，以及输出日志到控制台。我们将这三个插件添加到 Hapi.js 应用程序的插件列表中，并通过配置文件设置日志的需要记录的类型、目标及日志输出格式。
以下是使用 Good 进行日志记录的示例代码：
-- -------------------- ---- -------
----- ---- - ---------------------
----- ---- - ---------------------
----- ----------- - -------------------------------
----- ----------- - -----------------------------
----- ------ - -------------
----- -----
----- -----------
--
----- ---- - ----- -- -- -
----- -----------------
------- -----
-------- -
---------- -
-------- -
-
------- ---------------
----- ----------
----- -- ---- ---- --------- ---- ------ --- --
--
-
------- --------------
--
--------
-
-
-
--
--------------
------- ------
----- ----
-------- --------- -- -- -
--------------------- ------ -------
------ ------ ------
-
--
----- --------------
------------------- ------- --- --------------------
-
-------------------------------- ----- -- -
------------------
---------------
--
------Good 配置详解
在上述示例代码中，我们向 good 插件传递了一个包含 reporters 选项的对象。该选项表示需要使用的日志目标类型。这里我们只使用了一个名为 console 的日志输出目标，指将日志输出到控制台。
日志筛选和压缩使用 good-squeeze 模块。在 args 属性中，我们通过 { log: '*', response: '*', error: '*' } 对象指定需要记录的日志类型。例如，log 表示运行日志，response 表示响应日志，error 表示错误日志。这些类型可根据需要调整。
在 reporters 列表中的第二个元素是 good-console 模块。它负责输出日志消息到控制台。我们可以通过指定 format 选项来定制日志输出格式。例如，要输出时间戳和标签，请使用以下格式：
const GoodConsole = require('@hapi/good-console')
// [...]
{
module: 'good-console',
args: [{ format: 'YYMMDD/HHmmss.SSS [label] {data} ' }]
}使用 Good 输出到 Elasticsearch
除了将日志输出到控制台之外，Good 还支持将日志数据输出到 Elasticsearch 数据库中，以支持数据分析和更持久的存储。要将日志导出到 Elasticsearch，您需要安装和配置 good-elasticsearch 插件和 Elasticsearch 实例。
-- -------------------- ---- -------
----- ---- - ---------------------
----- ---- - ---------------------
----- ----------- - -------------------------------
----- ----------------- - -----------------------------
----- ------ - -------------
----- -----
----- -----------
--
----- ---- - ----- -- -- -
----- -------------- - -
------ -----------
----- ------------
----- -----
----- ----------------
---- -
--- - ------------------------------- -
-
-
----- -----------------
------- -----
-------- -
---- -
--------- ----
--
---------- -
-------------- -
-
------- ---------------
----- ----------
----- -- ---- ---- --------- ---- ------ --- --
--
-
------- ---------------------
----- ----------------
--
-
-
-
--
-- -----
----- --------------
-
-------------------------------- ----- -- -
------------------
---------------
--
------在上述示例代码中，我们使用 good-elasticsearch 模块配置 Elasticsearch 目标。在 args 数组中，我们传递一个对象，该对象指定了 Elasticsearch 索引名称、主机名和端口、TLS 证书及认证等。
总结
使用 Good 进行日志记录，可以轻松完成日志管理的工作，从而更好地维护 Hapi.js 应用程序。代码中的示例演示了如何配置 Good 日志插件，以及将日志数据导出到不同的目标（控制台或 Elasticsearch）。我们希望这篇文章对您有所帮助，并为您的日志记录操作提供实用的指导。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/649bd5c948841e98948975d1