npm 包 @dollarshaveclub/rollbar-check-ignore 使用教程

阅读时长 7 分钟读完

在前端开发中,我们经常需要使用到异常监控工具。其中 Rollbar 是一个备受欢迎的监控工具。它支持多种语言,并且可以自定义异常过滤规则。不过,在使用过程中,我们可能需要忽略某些异常,以免 Rollbar 发送大量无效信息导致干扰正常业务。而 @dollarshaveclub/rollbar-check-ignore 就是一个能够帮助我们快速过滤 Rollbar 异常的 npm 包。

安装

我们可以通过 npm 安装该包:

使用

1. 引入

我们需要在前端的入口文件中引入 @dollarshaveclub/rollbar-check-ignore 包。如果你使用的是 Vue、React 等框架,你可以在根组件中引入:

2. 配置

在 Rollbar 客户端初始化后,我们需要在 Rollbar 的配置选项中启用 @dollarshaveclub/rollbar-check-ignore 包:

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

3. 使用

在 Rollbar 发送异常之前,我们可以使用 @dollarshaveclub/rollbar-check-ignore 包中提供的 ignore 函数进行过滤处理。ignore 函数接收一个异常对象作为参数,并返回一个布尔值。当返回值为 true 时,该异常不会被发送到 Rollbar:

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

4. 配置规则

@dollarshaveclub/rollbar-check-ignore 包支持灵活的配置规则,我们可以根据自己的需要随意设置。规则的配置有两种方式:配置数组、配置函数。

配置数组

我们可以在包的入口文件中直接导出配置数组,数组的每一个元素为一个匹配规则:

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

配置数组中可以指定异常信息的匹配规则、忽略级别、是否指定指纹等。通过数组的项数,我们可以快速了解当前项目中配置的规则有哪些,并且方便修改、删除。

配置函数

我们可以将配置规则写成函数,函数接收一个异常对象作为参数,并返回一个配置项:

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

示例代码

下面是一个完整的 Rollbar 客户端初始化的示例代码,该代码启用了 @dollarshaveclub/rollbar-check-ignore 包并配置了规则:

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

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

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

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

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

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

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

该示例代码中,我们启用了 @dollarshaveclub/rollbar-check-ignore 包,并且配置了规则数组和规则函数。规则数组和规则函数可以根据实际需要去配置,以达到快速接入 Rollbar 并过滤无效异常的目的。

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