介绍
Fastify 是现代、高性能的 Node.js Web 框架。它的优点包括快速、低开销、开放的插件架构和良好文档支持。但是，Fastify 默认的日志系统可能并不适合每个人的需求。有时，我们需要更强大的日志系统来更好地记录和分析业务数据。本文将介绍如何在 Fastify 框架中使用 ELK 日志系统，并详细讲解如何配置、发送日志数据以及对 ELK 中的数据进行分析。
需求
在 Fastify 框架中使用 ELK 日志系统有以下需求：
- 给每个请求分配一个唯一标识符，并将其记录在请求日志中和响应日志中。
- 记录每个请求和响应的详细信息，包括 IP 地址、方法、路径、请求体和响应码。
- 使用结构化日志格式来记录请求和响应。
- 在发送日志数据到 ELK 系统之前，进行数据的处理和转换，以符合 ELK 系统的格式要求。
实现
安装依赖
首先，我们需要安装 fastify-plugin 和 log4js，它们是 Fastify 插件和日志库的最佳选择：
npm install fastify-plugin log4js --save
配置 ELK 系统
在使用 ELK 日志系统之前，我们需要先搭建一个 ELK 环境。这里不再赘述，可以参考 ELK 官方文档或搜索相关资料进行了解。
编写插件
接下来，我们编写一个 Fastify 插件来处理请求和响应，并发送日志数据到 ELK 系统。该插件需要遵循以下步骤：
- 使用
log4js创建一个 logger 对象，并配置输出日志格式以及日志级别（推荐使用 JSON 格式）。
const log4js = require('log4js');
const logger = log4js.getLogger();
logger.level = 'info';- 使用 Fastify 的
addHook方法为每个请求添加一个唯一标识符，并将其存储在请求上下文中。
fastify.addHook('onRequest', (req, res, done) => {
// 为每个请求添加一个唯一标识符
req.id = uuidv4(); // 使用 uuidv4 生成唯一标识符
done();
});- 使用 Fastify 的
addHook方法在请求结束后发送日志数据到 ELK 系统。在发送日志数据之前需要对数据进行处理和转换，以符合 ELK 系统的格式要求。
-- -------------------- ---- -------
----------------------------- ----- ---- ----- -- -
-- ----------- ---- --
----- ------- - -
------------- --- ---------------------
------------- -------
----- -------
--------- -----------
------- --------
--------- -----------
-------- ----------
------- ---------
---------------- ---------------
--
-- ------- --- --
----- ---------- - ------------------------
------------------------
-------
---将以上代码封装成一个 Fastify 插件，可以参考以下示例：
-- -------------------- ---- -------
----- ------ - ------------------
----- ------ - -------------------
-------------- - ----------------- -------- ----- -
----- ------ - -------------------
------------ - -------
---------------------------- ----- ---- ----- -- -
------ - ---------
-------
---
----------------------------- ----- ---- ----- -- -
----- ------- - -
------------- --- ---------------------
------------- -------
----- -------
--------- -----------
------- --------
--------- -----------
-------- ----------
------- ---------
---------------- ---------------
--
----- ---------- - ------------------------
------------------------
-------
---
-------
-配置 Fastify 服务器
接下来，我们需要将日志插件注册到 Fastify 服务器中。可以参考以下示例：
-- -------------------- ---- -------
----- ------- - ---------------------
----------------------------------------------
---------------- ----- ---- -- -
---------- -------- ------ ------- ---
---
-------------------- ----- -- -
-- ----- -
----- ----
-
------------------- --------- -- ---- --------
---分析日志数据
成功将日志数据发送到 ELK 系统后，我们就可以使用 Kibana 来分析和可视化这些数据了。具体操作可以参考 Kibana 官方文档或搜索相关资料。以下为示例查询语句：
GET /fastify-*/_search
{
"query": {
"match": {
"method": "GET"
}
}
}以上查询语句将会查询所有 method 为 GET 的请求数据。可以通过类似的方式进行复杂的数据分析和查询操作。在此不再赘述详细操作。
结论
在本文中，我们了解了如何在 Fastify 框架中使用 ELK 日志系统，并指导如何配置、发送日志数据以及对 ELK 中的数据进行分析。构建一个功能强大的日志系统不仅有助于记录业务数据，也可以为业务开发者提供快速定位问题和优化的机会。如果你的应用在生产环境中运行，那么强烈建议你使用类似的日志系统。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6770f749e9a7045d0d83b444