npm 包 good-bugsnag 使用教程

阅读时长 6 分钟读完

在前端开发中,难免会遇到页面出错或者异常,此时需要解决这些问题并且能够快速定位错误信息。Bugsnag 是一个流行的错误监控工具,它能够提供服务端和客户端的错误日志、错误统计和分析等功能,是一个非常优秀的错误监控工具。在前端开发中,我们可以使用 npm 包 good-bugsnag,它是一个支持 Bugsnag 的 Hapi 组件,在 Hapi 应用程序中捕获错误信息并自动将其报告到 Bugsnag。

安装

好消息是,我们只需执行简单的 npm install 命令即可安装 good-bugsnag:

使用

使用 good-bugsnag 很简单,只需对其进行配置,即可在 Hapi 应用程序中捕获错误信息并将其报告到 Bugsnag。下面是一个示例配置,其中 API_KEY 是 Bugsnag 给我们分配的 API key:

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

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

好像看起来有点长但是配置并不复杂,让我们逐步了解它:

第1步:首先我们使用 const goodBugsnag = require('good-bugsnag') 导入 good-bugsnag 库。

第2步:然后我们使用 Hapi 的 server.register 方法来注册 good-bugsnag。

第3步:在 options 中,我们定义了 reporters,它是一个数组。这个数组用来定义我们要使用的好货的容器,给出了以下选项:

  • 模块名称:这个是 good 将加载的 npm 模块的名称
  • options: 我们给定的的数组,它将传递给 good 模块 ,以产生有效的配置对象。

第4步:接下来是 good-bugsnag 的配置参数:

  • apiKey: 这是我们从 Bugsnag 中获得的 API 密钥。
  • releaseStage: 这是我们应用程序的当前阶段(e.g. development, staging, production)。
  • logger: 这代表 Bugsnag 在记录异常时所使用的 logger。
  • notifyReleaseStages: 由于许多开发人员需要在不同的阶段发布应用程序(例如,开发、测试、生产),因此 Bugsnag 也允许我们在指定的控制台中接收自定义消息。

第5步:最后,我们将 stdout 记录器添加到错误日志记录器容器中。这将使 good-bugsnag 将捕获到的日志信息打印到控制台上。

好了,现在您已经成功地为 Hapi 配置了 good-bugsnag。

实例

为了使该插件更加易于使用,这里提供了一个简单的示例。这个示例是如何在 Hapi 中使用 good-bugsnag 来捕获错误信息的。

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

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

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

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

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

在这个例子中,我们定义了一个返回错误信息的 API 接口,然后在 BUGSNAG 中捕获接口中的错误日志。现在,我们可以使用命令行运行它并查看开发控制台,从而了解 good-bugsnag 是否运行良好。

总结

在本文中,我们了解了如何使用 npm 包 good-bugsnag 来捕获和报告 Hapi 可能出现的错误和异常,并将其自动报告到 Bugsnag。我们了解了如何配置组件以满足我们的需求,并使用示例代码进行了实践演示。

在实践过程中,如果您遇到了困难或需要帮助,请参考官方文档或社区中相关的支持资源,祝您在开发中顺利。

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

纠错
反馈