失败者联署材料
A 类 失败者 javaScript 的客户端 .
安装
此软件包作为 npm 发布 @github/failbot。 。 。 .
❯ npm install @github/failbot
用法 :
const {Failbot, HTTPBackend, LogBackend} = require('@github/failbot')
const failbot = new Failbot({
app: 'my-cool-app',
backends: [new HTTPBackend({haystackURL: process.env.HAYSTACK_URL}), new LogBackend({log: console.log.bind(console)})]
})
try {
riskyThing()
} catch (error) {
failbot.report(error, {
extra: 'metadata',
can: 'be',
passed: 'as well'
})
}
提交报告
Failbot.report(error, metadata?, options?) 返回每个已配置后端的一个承诺。 报告是默认的最佳努力,因此交付失败决心 undefined。配置和有效载荷准备错误,包括编辑错误,同步抛出.
设定 rejectOnError 用后端发送错误拒绝 :
await Promise.all(failbot.report(error, metadata, {rejectOnError: true}))
HTTPBackend 将获取出错,超时,以及非-2xx响应视为交付失败. 默认5秒后请求超时 。 设定 timeoutMs 以配置超时 :
const backend = new HTTPBackend({
haystackURL: process.env.HAYSTACK_URL,
timeoutMs: 1_000
})
例外有效载荷
HTTP和日志报告包括一个具体运行时间的平台("node" 在节点.js和 "javascript" 和结构化 exception_detail 默认。 来自V8/Node/Chrome和Firefox/Safari的堆放框架已恢复正常,以便Failbog的调用者第一顺序。 遗产 class, (中文(简体) ), message字符串 backtrace 字段也用于兼容性.
消费者可以推翻默认 platform 财务报告和审定财务报表 exception_detail 通过元数据传递到 report。该格式继续拥有遗留错误字段、时间戳和JavaScript环境.
生成结构化例外字段编辑了Failbog全局上下文过滤器覆盖的已知证书模式,包括 URL 基本- 自动证书, cookie 值, 敏感的密钥值对等, 以及 GitHub 令牌 。 这种过滤有意保留了其他例外内容,如电子邮件地址和标识符. 提供打电话者 exception_detail 数值默认是逐字保存的,而遗留字段保留其已存在的值.
应用程序所有者负责将特定服务的敏感数据保留在例外情况之外。 配置 a redact 当应用程序处理默认证书模式无法识别的值时,函数:
const failbot = new Failbot({
app: 'my-cool-app',
backends: [new HTTPBackend({haystackURL: process.env.HAYSTACK_URL})],
redact(value) {
return value.replace(/service-specific-sensitive-pattern/g, '[app redacted]')
}
})
内建过滤运行于生成的结构化细节上. 然后,自定义功能运行在运出的有效载荷中每个JSON可序列化字符串上,包括生成和调用人提供的结构化细节、遗留字段和元数据。 它不适用于 sensitive_context。将其用于 GitHub 调用的额外格式 安全例外处理指导,例如授权和HMAC头,JWT,服务证书,以及特定应用程序的序列数据. 函数必须总是返回字符串,并且不能丢出。 添加应用程序编辑规则的测试,并在一个规则匹配时记录一个参数或安全日志条目,这样基础例外可以被固定.
自定义后端执行接收所配置的函数为第三个参数 report 在传输例外数据之前必须应用它。 捆绑的 HTTP 和日志后端自动做到这一点.
例外元数据应使用已登记 语义公约。Splunk 中必须具备但不能到达哨兵的数据可以放置在 Failbog 中 sensitive_context 对象 :
failbot.report(error, {
context: {'gh.example.repository.id': repositoryId},
sensitive_context: {'gh.example.repository.path': repositoryPath}
})
仅使用 sensitive_context 当需要保留该值时。 认证数据和其他受限制的内容在报告之前必须删除,而不是通过上述两种方式发送.
为了将报告的例外情况归于服务目录服务 catalog_service 标记包括在通过此库报告的所有例外中。 由于所有的摩达部署 OTEL_SERVICE_NAME 环境变量, catalog_service 被作为 OTEL_SERVICE_NAME。 。 。 .
您不需要覆盖此值, 但是, 如果您需要, 您可以通过 catalogService 页:1 Failbot 构造器 : const failbot = new Failbot({app: 'my-app', catalogService: 'my-catalog', backends: ...})。请注意,压倒一切的这一值可能使你的团队无法收到与大量例外情况有关的警报.