npm 包 winston-rsyslog2 使用教程

在前端开发中，我们经常需要记录应用程序的日志来帮助我们更好地理解问题或进行排查。在 Node.js 应用程序中，我们通常使用一个叫做 winston 的 Node.js 日志库。winston 能够轻松记录各种级别的日志，并且具有插件架构，可轻松与其他系统进行集成。本文将重点介绍和使用 winston-rsyslog2 插件。

简介

winston-rsyslog2 是一个插件，可以将日志输出到远程系统日志服务器 (rsyslog)，从而将日志记录结果发送到服务器端进行处理或存储。rsyslog 是一种系统日志守护进程程序，多用于 Linux 服务器等系统上，用来接收、处理、转发和存储系统日志。winston-rsyslog2 插件允许使用 winston 记录到 rsyslog 服务器，并增加了使用 rsyslog 文件标识符 (文件名和行号) 的能力。

安装

要使用 winston-rsyslog2，我们需要先安装它。这可以通过 npm 命令来完成：

npm install winston winston-rsyslog2 --save

配置

鉴于我们将使用 rsyslog 服务器作为我们的日志记录目标，我们还需要在本地系统上配置一些东西来允许我们连接和记录到 rsyslog。 在本地 Windows 机器上，你需要在你的 C:\Program Files (x86)\rsyslog 下创建一个名叫 rsyslog.conf 的文件，该文件应包括以下行：

#允许 TCP 连接
$ModLoad imtcp
$InputTCPServerRun 514

#从网络接收日志支持
$ModLoad imudp
$UDPServerRun 514

以便允许 TCP 和 UDP 连接，并允许从网络接收日志条目，我们可以使用 UDP 或 TCP 协议进行记录。在 Linux 上，你需要使用 systemd-journald、syslog-ng、rsyslogd 或类似于 syslog 的守护进程允许日志记录。

在您的应用程序中，您需要创建一个新的 winston Logger 并将其配置为输出到 rsyslog：

-- -------------------- ---- -------
----- ------- - -------------------
----------------------------

----- ------ - ----------------------
  ------ -------
  ----------- -
    --- ----------------------------
      ----- ------------
      ----- ---- -- -- --- -----------
    ---
  --
---

配置 logger 的具体参数如下：

• host – 要向其发送日志的 rsyslog 主机 (IP 地址或域名)。
• port – 使用的 rsyslog 服务器端端口 (默认为 514)。
• protocol – 使用的传输协议 (默认为 'tcp'。 可以为 'udp' 或 'tcp')。
• appName – rsyslog 配置文件中的'设备名'部分。 覆盖默认值 'app'。
• facility – rsyslog 的设施级别。 覆盖默认值 'local0'。
• localhost – 发送日志的本地主机名。 如果未指定，则使用默认本地主机名。
• port - 监听的端口号。 默认值为 514
• protocol - 传输协议。 默认值为 "udp"。
• rsyslogConf - rsyslog 配置文件路径。 默认值为 "/etc/rsyslog.conf"。
• rsyslogTag - rsyslog 中的标签名称。 覆盖默认值 "nodejs"。
• rsyslogPid - rsyslog 的进程 ID。 覆盖默认值 process.pid。
• rsyslogOptions - rsyslog 的其他选项。 格式类似于 '[key1=value1][key2=value2]'。

示例

现在，我们可以使用我们创建的 logger 来记录各种级别的日志，如下所示：

logger.log('info', '你好世界!');
logger.warn('这是一个警告!');
logger.error(new Error('出错了'));

我们还可以使用带有标记的日志，如下所示：

logger.log('info', '这是一个带有标记的消息', {
  file: __filename,
  line: __line,
});

其中，__filename 和 __line 都是 Node.js 中内置的常量值。您也可以直接传递文件和行号：

logger.log('info', '这是一个带有标记的消息', {
  file: '/path/to/my/file.js',
  line: 42,
});

结论

使用 winston-rsyslog2 插件，我们可以轻松地将日志发送到远程 rsyslog 日志服务器，以进行集中式记录、处理和存储。这使得我们能够轻松地进行故障排除和问题分析，以及更好地保留日志记录以进行日后的分析。这篇文章旨在介绍 winston-rsyslog2 的基本用法和配置，并希望读者可以在自己的应用程序中使用此插件进行日志记录。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671128dd3466f61ffe474