@shencom/plugins
这是一个插件的集合，目前已经包含以下插件
sentry-vue
Install
pnpm add @shencom/plugins
# or
yarn add @shencom/pluginsSentry
Sentry 是一个流行的错误监控平台，帮助开发者分析，修复问题，优化代码的性能。可以进行错误捕获，问题追踪，并提供问题详情，适用于多个平台，多种语言。
- 官方说明文档:
- Sentry站点: https://sentry.shencom.cn
- Sentry配置文档: https://docs.shencom.cn/plugins/sentry/#sentry-%E4%BD%BF%E7%94%A8
API
::: tip
提示:
目前只有 Vue 技术接入;
:::
Options
新增 Sentry 配置说明
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| scid | 租户 ID | String |
必填 | - |
| isDev | 是否在开发环境 | boolean |
必填 | - |
| isPro | 是否在正式环境 | boolean |
必填 | - |
改写默认 Sentry 配置说明
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| dsn | 项目唯一标识符 | String |
必填 | - |
| debug | 打开或关闭调试模式 | Boolean |
- | false |
| release | 版本号 | String |
- | |
| environment | 应用程序的当前环境 | String |
- |
isPro?production:test
|
| tracesSampleRate | 上报比例 | Number |
- |
isPro?1.0:0.5
|
| maxBreadcrumbs | 溯源步数 | Number |
- | 30 |
| attachProps | 是否上传 Vue 组件的 Prop 数据。 | Boolean |
- | true |
| logErrors | 是否使用原始 Vue 的 logError | Boolean |
- | true |
| attachStacktrace | 将堆栈跟踪附加到纯捕获消息/日志集成 | Boolean |
- | true |
| ignoreErrors | 上报过滤 | Array<String | RegExp> |
- | - |
| BrowserTracingOption | 浏览器跟踪选项 | BrowserTracingOptions |
- | - |
Methods
| 方法名 | 说明 | 参数 |
|---|---|---|
install |
初始化 | ISentryOption |
setScid |
设置 Scid | String |
setUserInfo |
设置用户信息 | Dictionary |
setRequest |
设置请求信息 | ISentryRequestOption |
clearUserInfo |
清除用户信息 | - |
captureEvent |
手动上报事件 | 参考官方文档说明 |
captureException |
手动上报错误事件 | 参考官方文档说明 |
captureMessage |
手动上报消息事件 | 参考官方文档说明 |
withScope |
临时上报数据，上报完成自动删除 | 参考官方文档说明 |
context |
继承 Sentry 方法实例 | - |