Gdy-report NPM

gdy-sentry-plugin

广电云非侵入式 Sentry 前端异常自动上报工具，可以一行代码实现 XHR/Fetch 异常收集、错误信息上报、页面性能统计等功能

目前暂时支持前端 js 项目，未来计划支持 node 等

引入方式

资源引用方式

下载 dist/gdy-report.min.js 至本地
使用 script 标签引入到 html 的头部（请放置在所有 js 资源之前）
配置使用 Report

<html>
  <head>
    <meta charset="UTF-8" />
    <title>report test</title>
    <script src="../dist/gdy-report.min.js"></script>
    <script>
      Report({
        dsn: '...Your Sentry Dsn'
      })
    </script>
  </head>
</html>

NPM 引入方式

npm install gdy-report --save
yarn add gdy-report

import Report from 'gdy-report'

参数配置

parameter name	describe	explain
dsn	sentry Dsn	必选项，从 sentry 项目中获取，请优先使用 https
version	当前项目版本	可从 package.json 取
env	环境变量	TEST/PRE/（空）
appid	唯一标识	可为 appid 或其他唯一标识
uin	用户 uin
name	项目名称
outtime	脚本延迟上报时间	默认 300ms
filterUrl	url 过滤列表	过滤列表内 url ，将不再自动上报
apiRules	api 规则列表	使用固有格式定制 api 校验规范（不符合的 api 将上报），详情见单独说明
isPage	是否上报页面性能数据	默认 false
isAjax	是否上报 ajax 数据	默认 true
isError	是否上报错误信息	默认 true

API Rules

单个 rule 示例：

{
  url: 'xxxxx',
  rules: {
    data: { name: 'data', permission: [] },
    identify: { name: 'data', permission: [] },
    msg: { name: 'errorMessage', permission: [] }
  }
}

data、identify、msg 为固有字段，分别匹配所需要上报的数据体的 data、errorCode、msg 部分。其中的 name 为 response 体内对应项的字段名，permission 为允许的值的集合数组（为空时表示所有值都被允许），重复值暂时是不被允许的，会引发插件错误。

若 response 内相应 name 的数据，不为其 permission 中任一元素，则该条记录将会被上报至 sentry

当前内部已集成最基础的 Api 规则，无须自定义：

{
  url: 'guangdianyun.tv',
  rules: {
    data: { name: 'data', permission: [] },
    identify: { name: 'errorCode', permission: [0, 1] },
    msg: { name: 'errorMessage', permission: [] }
  }
},
{
  url: 'aodianyun.com',
  rules: {
    data: { name: 'data', permission: [] },
    identify: { name: 'code', permission: [0] },
    msg: { name: 'msg', permission: [] }
  }
}

参考示例

import Report from 'gdy-report'

Report({
  dsn: 'https://xxxxxxxxxxxxxxxxx@sentry.guangdianyun.tv/x',
  version: '1.0.2',
  env: 'TEST',
  appid: 'xxxxxxxxx',
  uin: 1000,
  name: 'Gdy-Sentry',
  outtime: 300,
  filterUrl: ['xxx.xxx.com', 'yyy.yyy.com'],
  isPage: false,
  isAjax: true,
  isError: true
})

外部命令

Report.init

提供在工具加载后初始化 Sentry 信息的功能，支持对象参数导入，对象支持 3 个参数（dsn，version，env），配置规则同配置列表所示

const option = {
  // sentry dsn
  dsn: 'https://xxxxxxxxxxxxxxxxx@sentry.guangdianyun.tv/x',
  // 版本信息
  version: '1.0.0',
  // 环境变量
  env: 'TEST'
}
Report.init(option)

Report.setUser

提供在工具加载后设置 Sentry 用户信息的功能，支持 4 个参数（appid, uin，name，env），配置规则同配置列表所示

Report.setUser('xxxxxx', 1000, 'Lcps', 'TEST')

Report.api

提供在自定义上报 Api 异常的功能，支持 3 个参数（appid, uin，data），其中 data 为数据体，配置规则同配置列表所示

const { data } = await API()
Report.api('xxxxxx', 1000, data)

Report.info

提供在自定义上报提示信息的功能，支持 4 个参数（appid, uin，msg, data），其中 msg 为信息内容，data 为数据体，配置规则同配置列表所示

const str = 'hello world'
Report.api('xxxxxx', 1000, 'init message', str)

Report.error

提供在自定义上报提示信息的功能，支持 4 个参数（appid, uin，msg, data），其中 msg 为错误内容，data 为数据体，配置规则同配置列表所示

const error = 'data is undefined'
Report.api('xxxxxx', 1000, 'i get error', error)

TODO

同时支持广电云 & 奥点云基本数据结构
支持外部指令
支持自定义域名过滤
支持外部导入数据结构规则
支持 React
支持 Node 环境

gdy sentry frontend report

@sentry/browser @sentry/integrations

@infinitebrahmanuniverse/nolb-gd @everything-registry/sub-chunk-1728 @zalastax/nolb-gd

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago