npm 包 @bugsnag/plugin-contextualize 使用教程

阅读时长 5 分钟读完

简介

@bugsnag/plugin-contextualize 是一个 Bugsnag 的 JavaScript 客户端库内的插件,它可以帮助您更好的定位您应用程序中的错误。该插件可以通过添加有关错误发生背景信息的元数据来扩展 Bugsnag 消息。这些上下文数据可以帮助您在查看错误报告时更快地进行故障排除。

安装

通过 NPM 安装 @bugsnag/plugin-contextualize:

使用

使用 @bugsnag/plugin-contextualize 非常简单。在初始化 Bugsnag 且安装插件之前,您需要编写一个函数来为您的应用程序设置或者获取上下文数据。例如:

-- -------------------- ---- -------
----- -------- ---------------- -
  ----- -------- - ----- ------------------------------------------
  ----- ---- - ----- ----------------
  ------ -
    ------------ -----------------
    ----- -
      ------ -----------
      ----- ----------
      --- -------
    -
  --
-
展开代码

然后,您需要在 Bugsnag 系统中设置您的 API 密钥和应用程序的其他信息,如下所示:

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

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

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

----- -------- -------------- -
  ----- ----------- - ----- -----------------
  
  -- -- ------- -----
  ------------------------------------- -------------
-
展开代码

请注意,您需要为每个错误处理程序设置上下文数据。

示例

下面是一个完整的代码示例,演示了如何使用 @bugsnag/plugin-contextualize:

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

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

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

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

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

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

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

-------------
展开代码

在此示例中,我们使用 Bugsnag 捕获 JavaScript 错误,并使用 @bugsnag/plugin-contextualize 插件设置错误的运行环境和用户上下文数据。我们编写了一个异步函数 getContextData(),它从 API 获取数据,然后将数据添加为 Bugsnag 上下文数据。最后,我们调用 initialize() 函数,这将启动应用程序和错误处理程序。

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