@gatekeeper_technology/rollbar-utils

中文文档
1.2.5发布于 2026/07/10ISCTypeScriptCommonJS近 30 天下载 2.3万

这个代码提供了在节点环境中处理并记录Rollbar集成错误的功能,包括根据某些条件重新安排任务并触发Rollbar错误记录.

中文使用文档
文档目录30 节
  1. 懒人的执行
  2. index.ts
  3. index.js
  4. package.json
  5. tsconfig.json (仅用于类型脚本):
  6. 详细使用
  7. 在主机中处理出错 catch
  8. 自定义错误行为 throwError
  9. 自定义错误处理
  10. status-not-pending
  11. attachments-uploading
  12. 更改日志
  13. [1.2.4] - 2025-01-29
  14. [1.2.3] - 2024-08-07 (中文(简体) )
  15. [1.2.2] - 2024-07-23
  16. [1.2.1] - 2024-01-08
  17. [1.2.0] - 2023-10-12
  18. [1.1.2] - 2023-09-29
  19. [1.1.1] - 2023-09-27
  20. [1.1.0] - 2023-09-15
  21. [1.0.9] - 2023-09-15
  22. [1.0.8] - 2023-09-15
  23. [1.0.7] - 2023-09-15
  24. [1.0.6] - 2023-09-01
  25. [1.0.5] - 2023-09-01 (中文(简体) )
  26. [1.0.4] - 2023-09-01 (中文(简体) )
  27. [1.0.3] - 2023-09-01 (中文(简体) )
  28. [1.0.2] - 2023-08-18
  29. [1.0.1] - 2023-08-18
  30. [1.0.0] - 2023-07-21

滚筒

这个代码提供了在节点环境中处理并记录Rollbar集成错误的功能,包括根据某些条件重新安排任务并触发Rollbar错误记录.

懒人的执行

index.ts

import RollbarUtil from "@gatekeeper_technology/rollbar-utils";

let rollbar: RollbarUtil;

export async function run(this: TaskContext, params: any) {
    console.log(`🏁 Task started (in ${CloudCode.task.env}) with params: ${JSON.stringify(params ?? (params = {}), null, 2)}`);
    rollbar = new RollbarUtil({
        access_token: process.env.ROLLBAR_ACCESS_TOKEN,
        params: params,
        self: this
    });

    try {
        await runTask.call(this, request_object);
    } catch (error) {
        await rollbar.handleError(error);
    }
}

index.js

  • 合作时 .js 文件,您可以导入下面的软件包:
    const { default: RollbarUtil } = require("@gatekeeper_technology/rollbar-utils");
    

package.json

  • 不需要导入 Rollbar
  • 手动更新您的依赖性
    "dependencies": {
      "@gatekeeper_technology/rollbar-utils": "<latest_version>",
      "@journeyapps/cloudcode": "1.12.0"
    },
    

tsconfig.json (仅用于类型脚本):

  • 替换您的 tsconfig.json 文件为 :
{
    "extends": "@journeyapps/cloudcode-build/task-tsconfig",
    "compilerOptions": {
        "esModuleInterop": true,
        "allowJs": false,
        "skipLibCheck": true
    }
}
  • 别忘了用部署环境变量 ROLLBAR ACCESS TOKEN 来注册你的滚巴访问符 . 在测试时,可以使用被钉入 #rollbar-testing-spam 黑频道

  • 说明:如果在复制和粘贴时发生倒挂错误,请尝试刷新OXIDE.

详细使用

在主机中处理出错 catch

await rollbar.handleError(error);

或有选项:

await rollbar.handleError(error, { reschedule_task: false });

旗帜

  • env: 指定要日志或重新安排出错的环境。 默认是 "production"。 。 。 .
    • 可能会 string 或者说 string[]
  • reschedule_task: 故障时自动重新安排任务. 默认是 true。 。 。 .
  • trigger_rollbar: 记录错误到 Rollbar 。 默认是 true。 。 。 .

自定义错误行为 throwError

这个 throwError 函数允许您在可配置的设置下丢出自定义错误。 您可以控制是触发 Rollbar 日志还是重新安排任务 。 默认设置为 { trigger_rollbar: true, reschedule_task: false }。 。 。 .

这是如何使用 throwError数字 :

    rollbar.throwError("Will not trigger rollbar", { trigger_rollbar: false });
    rollbar.throwError("Will trigger rollbar, but not reschedule", { trigger_rollbar: true, reschedule_task: false });
    rollbar.throwError("Will not trigger rollbar, and not reschedule", { trigger_rollbar: false, reschedule_task: false });

说明: 所有动作只在指定的环境中执行,默认为 "production."

自定义错误处理

我们的功能对如何处理某些类型的错误提供了精细的控制。 本节解释如何处理两个具体的自定义错误: status-not-pending 财务报告和审定财务报表 attachments-uploading。 。 。 .

status-not-pending

这种类型的错误被认为是"阻断"错误. 如果发生这样的错误, 任务将不会重试 .

attachments-uploading

对于此错误类型, Rollbar 日志以重试计数为条件. 工具仅在最后的重试上登录一个 Rollbar 错误 .

更改日志

[1.2.4] - 2025-01-29

更新

  • 对最新版本的依赖

[1.2.3] - 2024-08-07 (中文(简体) )

更新

  • 对最新版本的依赖

[1.2.2] - 2024-07-23

更新

  • 对最新版本的依赖

[1.2.1] - 2024-01-08

已添加

  • 在 CC 参数中对象的 CC 参数中添加对象 ID 函数 .

[1.2.0] - 2023-10-12

已添加

  • 引入了 throwError 函数,用于更多的颗粒错误处理 .
  • 允许设置可重试或不重试的自定义错误 .
  • 也可以设定为登录或不登录于 Rollbar.

已更改

  • 从单一文件到多文件架构的重构寄存器结构.
  • 提高代码的模块性和可维护性.
  • 改进了读取方法

[1.1.2] - 2023-09-29

已更改

  • 更改了 Rollbar 配置验证, 只登录控制台中的错误, 而不会丢出错误 .
  • 如果没有设置入洞, 它默认为“ 测试 ”
  • 如果微量 id没有设置, 它默认为“ 不适用 ”

[1.1.1] - 2023-09-27

已添加

  • 强化错误分析: 软件包现在检查出错的名称,消息,并导致确定是否应当忽略出错.

已更改

  • 更新 README.md 包括简明和全面的使用说明.
  • 重命名为 env_to_error 旗为 env。 。 。 .
  • 这个 env 旗下现在指定了 CC 任务可能触发滚动栏和重新安排的环境.
  • 所有coper.warn或coper.error都改为Coper.log,因为并不总是记录信件.

[1.1.0] - 2023-09-15

已添加

  • 'status- not-vend' 错误不再重新安排任务或登录到滚动栏 .

已更改

  • 函数转换为类
  • 改进控制台记录.
  • 更好的例外处理

固定

  • 泰宝
  • 如果一个 CC 任务没有重新安排时间, 滚动栏会重新触发, 即使没有被请求 .

[1.0.9] - 2023-09-15

固定

  • 在1.0.7.版本中还原了钩子函数变化.

[1.0.8] - 2023-09-15

固定

  • 无法找到上下文的bug, 因为钩子函数为 async .

[1.0.7] - 2023-09-15

已更改

  • 将函数改为钩函数.

固定

  • 错误名称未正确读取的错误 .
  • 错误所在 null编号 :undefined retry count 阻止了任务重试 .

[1.0.6] - 2023-09-01

已更改

  • 更好的控制台日志!

固定

  • 试图在没有滚动栏访问符的情况下登录任务的错误

[1.0.5] - 2023-09-01 (中文(简体) )

已添加

  • 添加了对两个导出函数的评论,以便帮助开发者.
  • 软件包内部处理出错 .

固定

  • 一个“ 应重新安排” 旗被忽略的bug .

[1.0.4] - 2023-09-01 (中文(简体) )

已添加

  • 添加了可选“ 应重新安排” 旗帜 .

删除

  • 取消了 TS 类型检查“ this” .

[1.0.3] - 2023-09-01 (中文(简体) )

已添加

  • 添加了“ 附加加载” 检查 .

已更改

  • 已执行"trigger rollbar"旗.
  • 改进了控制台日志.

固定

  • 泰波已经修好了.

[1.0.2] - 2023-08-18

已添加

  • 已添加.d.ts文件 .

固定

  • 解决待办事宜

[1.0.1] - 2023-08-18

已更改

  • 将软件包公之于众

[1.0.0] - 2023-07-21

已添加

  • 初始功能通过滚动栏记录出错, 如果它不重排时程 .

版本与发布记录

@gatekeeper_technology/rollbar-utils 共发布 19 个版本,首次发布于 2023/07/21;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.2.5latest2026/07/104 个月前
1.2.42025/01/291.8 年前
1.2.32024/08/072 年前
1.2.22024/07/232 年前
1.2.12024/01/082 年前
1.2.02023/10/133 年前

关于 @gatekeeper_technology/rollbar-utils 的常见问题

@gatekeeper_technology/rollbar-utils 是什么?

这个代码提供了在节点环境中处理并记录Rollbar集成错误的功能,包括根据某些条件重新安排任务并触发Rollbar错误记录.

如何安装 @gatekeeper_technology/rollbar-utils?

在项目目录运行 npm install @gatekeeper_technology/rollbar-utils,或使用 pnpm add / yarn add / bun add。

@gatekeeper_technology/rollbar-utils 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gatekeeper_technology/rollbar-utils 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gatekeeper_technology/rollbar-utils 可以商用吗?

@gatekeeper_technology/rollbar-utils 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gatekeeper_technology/rollbar-utils 的下载量有多少?

根据 npm 官方下载统计,@gatekeeper_technology/rollbar-utils 在 2026/10/16 – 2026/11/14 这 30 天内被下载 23,278 次,日均约 776 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gatekeeper_technology/rollbar-utils 还在维护吗?

最新版本 1.2.5 发布于 2026/07/10(4 个月前);至今共发布 19 个版本,其中过去 12 个月发布了 1 个;首次发布于 2023/07/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。