在前端开发中，我们经常需要记录日志来帮助我们定位问题和分析系统运行情况。@chitkosarvesh/winston-logstash 是一个能够将 Node.js 应用程序中的日志传输到 Logstash 的 npm 包，本文将为大家介绍如何使用此包。
安装
我们可以通过 npm 安装这个包：
npm install @chitkosarvesh/winston-logstash
使用
在使用之前，我们需要知道一些基本的概念：
- Logstash：一个用于日志收集、处理和转发的开源工具。
- winston：一个 Node.js 的日志库，可以在控制台、文件、数据库等不同位置记录日志。
@chitkosarvesh/winston-logstash 是一个可以将 winston 日志记录到 Logstash 中的插件。
下面是一个使用示例：
-- -------------------- ---- -------
----- ------- - -------------------
----- ----------------- - -------------------------------------------
----- ------ - ---------------------
------ -------
----------- -
--- -------------------
----- ---------------------
----- -----
----- -
------- ---------
--
---
--
---
------------------ ----- -- -- ---- ----------这个示例中，我们创建了一个基于 winston 的 logger 对象，并使用 logstash transport 将日志传输到 Logstash。其中：
host和port表示 Logstash 的主机名和端口号；meta是一个可选属性，它表示一个对象，将额外的元数据添加到日志信息中。
除了上面的示例代码，还有不同的配置方法，我们可以写成配置文件通过 winston.createLogger 配置文件形式传入配置，例如：
winston.config.json
-- -------------------- ---- -------
-
----------- -
------- ----------------------------------
---------- -
------- ---------------------
------- -----
------- -
--------- --------
-
-
-
-index.js
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------ - -------------------------------- ----- ---------- - ---------------------------- -- - ----- ---- - ------------ ----- --------- - ----------------------------- ------ --- ----------------------- -- ----- ------ - ---------------------- ---------- --
这种方式可以方便的进行 winston 配置管理和 winston.transport 的构造，能够更加方便的添加和卸载 winston.transport，并且可以适配 log 多个主题的多个 transport。
参数
@chitkosarvesh/winston-logstash 支持下列参数：
- host: Logstash 主机的地址。
- port: Logstash 监听的端口号。
- protocol: Logstash 与 winston-logstash 之间通信的协议，目前仅支持 UDP 协议。
- applicationName: 该应用程序的名称。
- logstashBasicAuthEnabled: 是否启用基本身份验证。
- logstashUsername: Logstash 基本身份验证的用户名。
- logstashPassword: Logstash 基本身份验证的密码。
- maxDelayBetweenReconnection: 当 TCP 连接中断时等待多长时间重试，以毫秒为单位，默认值为 30,000 毫秒。
- meta: 用于添加额外元数据的对象。
结语
通过本文，我们可以学会如何使用 @chitkosarvesh/winston-logstash 这个 npm 包将 Node.js 应用程序中的日志传输到 Logstash 中。这个包的使用可以让我们更加方便地管理日志，并且帮助我们更好地理解系统情况，定位问题。感谢 @chitkosarvesh 为开发者们的贡献！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a430d092702382242f