npm 包 loggly-jslogger 使用教程

阅读时长 6 分钟读完

介绍

loggly-jslogger 是一个在前端记录日志的 npm 包,它可以将各种类型的日志消息发送到 Loggly,这是一个云日志管理服务,使用它可以更好地掌握应用程序的运行状况并诊断错误。

本文将为大家介绍如何使用 loggly-jslogger。

安装

使用 npm 可以很容易地安装 loggly-jslogger:

配置

首先,我们需要在 Loggly 上创建一个账户,并获取一个 token。这个 token 用来确保只有本应用程序可以发送日志到 Loggly 的帐号。拿到 token 后,我们只需要在应用程序中的初始化阶段进行配置。以下是一些常见的配置选项:

-- -------------------- ---- -------
-------------
  ------ --------------------
  ---------- ------------------------
  ----- ----------- --------
  ------------------ -----
  --------------- -
    --------- ------------------------
  --
  -------------- -
    ----------- ---
    ------------ ----
  -
---
  • token:这个参数是必须的,用于验证请求,确保只有有效的信息被发送到 Loggly。
  • subdomain:你的 Loggly 账户的子域名
  • tags:一个数组,包含用于日志记录的标记。
  • sendConsoleErrors:设置为 true 后,loggly-jslogger 会自动捕获浏览器 console 的错误,并把它们发送到 Loggly。这是非常有用的,因为 console 的错误经常被忽略。
  • additionalData:添加一些自定义数据到每条日志记录。该对象将被自动序列化为 JSON。
  • bufferOptions:该对象包含两个属性:
    • maxRecords:日志记录缓冲区的大小。默认为 50 条。
    • maxWaitTime:缓冲区在填满之前最大等待时间(以毫秒为单位)。如果已经过了该时间,缓冲区被完全填满,启动网络请求。默认为 1000 毫秒。

发送日志

每次需要发送日志时,在应用程序中发起 Loggly 日志记录:

以上是发送不同类型的日志,可以使用多个附加信息参数:

或者,你可以通过传递一个字符串数组来将多个消息附加到一条日志记录中:

示例代码

下面是一个完整的,基于 React 的应用程序示例:

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

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

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

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

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

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

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

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

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

当用户单击按钮时,日志记录会被发送到 Loggly。我们可以方便地跟踪或诊断整个应用程序或特定组件的问题。

总结

在本文中,我们介绍了如何使用 loggly-jslogger npm 包来记录前端应用程序的日志消息并将它们发送到 Loggly。我们深入探讨了如何配置选项,以及如何使用不同类型的日志记录。这对于对 JavaScript 应用程序的长期维护和可靠性至关重要。

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