npm 包 splunk-logging 使用教程

阅读时长 4 分钟读完

在前端开发中,日志记录是非常重要的一项工作。它可以帮助开发者了解应用程序的运行情况,诊断错误和问题,以及改进应用程序的性能。

Splunk 是一个流行的日志管理平台,可以用于收集、搜索、分析和可视化各种类型的日志数据。在这篇文章中,我们将介绍如何使用 npm 包 splunk-logging 来将日志数据发送到 Splunk 平台。

安装

安装 splunk-logging 相当简单,只需在终端中运行以下命令:

配置

使用 splunk-logging 必须要连接到 Splunk Enterprise 或者 Splunk Cloud,所以必须要提供以下信息:

  • Splunk Enterprise 或 Splunk Cloud 的 HTTP Event Collector(HEC)的 URL 和端口号
  • 提供给 HEC 的 Token

可以通过运行以下命令来启用 HEC 和获取 Token:

  1. 登录 Splunk 平台
  2. 点击 Settings
  3. 点击 Data inputs
  4. 选择 HTTP Event Collector
  5. 点击 + Add new
  6. 配置连接

具体来说,需要提供以下信息:

  • Event Source 选择 _json
  • Event Destination 选择 index
  • Index 设置为 _raw
  • Authorization 选择 Token
  • Token 设置您自己的 Token,并记下该值
  • 点击 Review 以确保设置正确
  • 点击 Submit

Token 值是使用应用程序时需要提供给 HEC 的凭据。

现在,我们可以在应用程序中配置 Splunk 日志器。首先,导入 splunk-logging:

然后,创建一个事件记录器对象:

YOUR_HEC_TOKEN 替换成上面步骤中获取到的 Token,将 https://splunk-hec-url:8088 替换成您自己的 HEC URL。

调用 Logger 对象的发送事件方法,将日志数据发送到 Splunk 平台:

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

在这个示例中,我们发送一个文本消息,指定了消息的等级(severity)以及键值对的元数据信息。您可以使用 metadata 对象来记录日志的来源、类型和其它相关信息。

除了发送文本消息之外,还可以使用 JSON 对象来发送结构化数据:

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

总结

在这篇文章中,我们介绍了如何使用 npm 包 splunk-logging 来将日志数据发送到 Splunk 平台。我们讨论了如何配置和使用 Splunk 日志器,以及如何发送不同类型的日志数据。如果您正在开发前端应用程序并想要将日志记录到 Splunk 中,那么 splunk-logging 可以帮助您完成这项任务。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600670a58ccae46eb111f1db

纠错
反馈