@hawk.so/nodejs (韩语)
节点.js 出错 鹰
初始参数
初始化参数 :
| 名称 | 类型 | 所需经费 | 说明 |
|---|---|---|---|
token | 字符串 | 所需经费 | 您的项目的整合 Token |
release | 字符串 | 选项 | 发行时唯一的标识符. |
context | 对象 | 选项 | 您想要随每个消息传递的任何数据 . |
disableGlobalErrorsHandling | 布尔 | 选项 | 不初始化全局错误处理 |
beforeSend | 函数( 事件) qq事件 qq 虚空 | 选项 | 发送前过滤数据 。 返回已修改的事件, false 放弃活动. |
breadcrumbs | false 或对象 | 选项 | 过 false 以禁用。 要配置的通过选项对象(参见 面包屑。默认:已启用. |
使用量
- 创建 一个账户,并获得一个整合托肯.
- 添加 @hawk.so/nodejs (韩语) 软件包.
Require并初始化模块.
安装
使用国家防范机制或 Yarn 安装 Catcher @hawk.so/nodejs。 。 。 .
$ npm install @hawk.so/nodejs --save
$ yarn add @hawk.so/nodejs
需要 HawkCatcher 模块
通用JS项目
const HawkCatcher = require('@hawk.so/nodejs').default;
无害环境管理项目
import HawkCatcher from '@hawk.so/nodejs';
鹰卡捷
在您的工程条目文件中初始化 HawkCatcher, 方法是通过一个工程符号 .
const HAWK_TOKEN = 'eyJhb...VPsc=';
HawkCatcher.init(HAWK_TOKEN);
HawkCatcher 添加听众 uncaughtException 财务报告和审定财务报表 unhandledRejection 自己来.
禁用全局错误处理
如果您不想初始化全局例外处理器, 请使用 disableGlobalErrorsHandling 一、导 言.
HawkCatcher.init({
token: HAWK_TOKEN,
disableGlobalErrorsHandling: true,
});
然后,你可以手动抓住事件.
全球背景
您可以定义要抓取的所有事件的全局背景 .
HawkCatcher.init({
token: HAWK_TOKEN,
context: {
myOwnDebugInfo: '1234'
}
});
释放
要标记事件到特定释放 通过 release 标识符字符串为 intial 配置.
HawkCatcher.init({
token: 'INTEGRATION TOKEN',
release: process.env.releaseId
})
人工捕获例外
之后 初始化 您可以在任何工程的试捕构造中手动捕获例外.
刚刚 需要 HawkCatcher 软件 打电话 .send() 方法.
try {
throw new Error('My lovely error');
} catch (e) {
HawkCatcher.send(e);
}
如果HawkCatcher没有初始化的话 .send() 方法不会做什么.
事件背景
您可以通过任何信息作为单个活动的上下文参数.
try {
throw new Error('User not found');
} catch (e) {
HawkCatcher.send(e, {
myOwnDebugInfo: '1234'
});
}
如果存在此上下文对象, 则会与全局上下文合并 .
用户
您可以将用户数据作为第三段发送.
可用字段 :
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
| 编号 | string|number | 所需经费 | 用户标识符 |
| 名称 | string | - 说吧 | 用户名 |
| url 密码 | string | - 说吧 | 用户配置文件 URL |
| 图像 | string | - 说吧 | 用户配置文件 pic URL |
try {
throw new Error('Cannot create a new post');
} catch (e) {
HawkCatcher.send(e, {}, {
id: 1234,
name: 'Taly'
});
}
面包屑
Breadcrumbs 跟踪事件导致出错,为调试提供上下文. 与 API 相同 @hawk.so/javascript (添加, get, clear); 在节点中没有自动跟踪取取/导航/点击,只有手动面包屑.
默认配置
默认情况下,面包屑是启用的(只有定制面包屑):
HawkCatcher.init({
token: 'INTEGRATION_TOKEN'
// breadcrumbs enabled by default
});
残废面包屑
完全禁用面包屑:
HawkCatcher.init({
token: 'INTEGRATION_TOKEN',
breadcrumbs: false
});
自定义配置
配置面包屑(酌情与联署材料相同):
HawkCatcher.init({
token: 'INTEGRATION_TOKEN',
breadcrumbs: {
maxBreadcrumbs: 20,
beforeBreadcrumb: (breadcrumb, hint) => {
if (breadcrumb.category === 'auth' && breadcrumb.data?.userId) {
return false; // Discard
}
return breadcrumb;
}
}
});
面包屑选项
| 选项 | 类型 | 默认 | 说明 |
|---|---|---|---|
maxBreadcrumbs | number | 15 | 要储存的面包屑最多。 达到限值后取出最古老的面包屑(FIFO). |
beforeBreadcrumb | function | undefined | 胡克在每块面包屑被储存之前就打电话了 接收 (breadcrumb, hint)返回经过修改的面包屑来保存它, false 丢弃. |
手工面包屑
手动添加自定义面包屑. Breadcrumbs 累积在缓冲器中,并附着在每起事件上,直到通过 HawkCatcher.breadcrumbs.clear()数字 :
HawkCatcher.breadcrumbs.add({
type: 'logic',
category: 'auth',
message: 'User logged in',
level: 'info',
data: { userId: '123' }
});
面包屑方法
与联署材料的捕捉者相同:
// Add a breadcrumb
HawkCatcher.breadcrumbs.add(breadcrumb, hint);
// Get current breadcrumbs
const breadcrumbs = HawkCatcher.breadcrumbs.get();
// Clear all breadcrumbs
HawkCatcher.breadcrumbs.clear();
敏感数据过滤
使用 beforeSend() 在发送到 Hawk 之前, 勾通过滤数据 .
- 返回已修改的事件 ——将发送修改后的事件
- 返回时
false——事件将完全放弃 - 任何其它值无效 ——原事件按正时发送(已登录警告)
HawkCatcher.init({
token: 'INTEGRATION TOKEN',
beforeSend(event) {
// Strip sensitive user data
if (event.user && event.user.name) {
delete event.user.name;
}
return event;
}
});
完全丢弃一个事件 :
HawkCatcher.init({
token: 'INTEGRATION TOKEN',
beforeSend(event) {
if (event.title.includes('ignore-me')) {
return false;
}
return event;
}
});
许可证
本项目根据以下规定获得许可证: GNU 阿费罗通用公共许可证 v3.0 (AGPL-3。 。 。 . 见 自由主义 完整文本的文档.