y-monitor-sdk v1.0.25
install
npm i y-monitor-sdk
build
npm run build
lint
yarn lint
参数
参数名 | 类型 | 描述 | 默认值 | Online | version |
---|---|---|---|---|---|
appName | String | 标志项目名 | app_release | √ | 1.0.1 |
release | String | 项目版本号 | 1.0.0 | √ | 1.0.1 |
traceReportUrl | String | trace上报地址 | http://localhost:8888/traceReport | √ | 1.0.1 |
perfReportUrl | String | 性能上报地址 | http://localhost:8888/PrefReport | √ | 1.0.5 |
pointReportUrl | String | 行为埋点上报地址 | http://localhost:8888/pointReport | ||
onAjax | Boolean | 是否开启ajax劫持 | false | √ | 1.0.1 |
onTrace | Boolean | 是否开启trace链路监控 | false | √ | 1.0.1 |
onRoute | Boolean | 是否开启路由劫持 | false | √ | 1.0.5 |
onError | Boolean | 是否开启错误监听 | false | ||
onEnviroment | Boolean | 是否采集环境信息 | false | √ | 1.0.5 |
onPerformance | Boolean | 是否采集性能数据 | false | √ | 1.0.5 |
onBehavior | Boolean | 是否开启行为监控 | false | ||
onPoint | Boolean | 是否开启行为埋点 | false | ||
onClick | Boolean | 是否全量监听click | false | ||
onInput | Boolean | 是否全量监听input | false | ||
sample | Number | 采样率 | 1 | ||
allow | Object | 白名单,默认为'*' | {allowApis:'*'} | √ | 1.0.5 |
ignore | Object | 黑名单 | {ignoreErrors:[],ignoreUrls:[],ignoreApis:[]} | √ | 1.0.3 |
trace监控使用
客户端渲染的使用
import YmonitorSDK from 'y-monitor-sdk';
new YmonitorSDK({
traceReportUrl: '/operation-admin/ymonitor/report ',
appName: 'web-cloud-operation-admin',
onAjax: true, //允许ajax劫持
onTrace: true, //允许trace监听,依赖于上述的onAjax的开启
allow: { //白名单,无特殊需要就不改动。
allowApis: ['*'],
},
ignore: { //黑名单,这里加入的参数会被拦截
//如果以script形式跨域加载第三方脚本,请把它加在ignoreApis里
//example: ignoreApis: [/baidu/,/sougou/]
ignoreApis: []
}
});
将traceReportUrl改为自身适用的上报接口地址,将appName改为自己的项目名,在入口文件引入代码即可。
服务端渲染的使用
这里以nuxt的服务端渲染为例:
在nuxt.config.js下,加上
plugins: [
{src: '~/plugins/sdk.js', ssr: false}
],
src里的地址指向一个文件,文件代码与客户端引入的代码一样即可,注意ssr必须设置为false
update log
v1.0.25
1.新增支持fetch底层原理的api trace请求监控
2.修正report上报的contextPath值由 ”页面地址“ 改为 " 页面地址 --> 请求url"
v1.0.24
1.修正onPerformance参数错误问题
v1.0.23
1.修正黑名单匹配错误问题
2.修正黑白名单格式化问题
v1.0.5
1.补全说明文档
2.去除所有三方插件依赖
3.性能监控和行为监控demo级功能初始化
4.支持服务端渲染的trace监听
5.完善api错误信息捕获机制
6.新增上报失败重传机制和多次失败停止机制
v1.0.4
1.修正上报时的appName统一以 web- 起头
2.修正traceId的uuid生成算法
3.新增trace监控时的错误信息捕获功能
v1.0.3
1.新增防抖合并上报2.5s
2.新增网页退出兜底上报功能
3.新增黑名单功能,以正则为筛选条件
v1.0.2
1.eslint代码风格规范
2.隔离report接口自身的trace
v1.0.1
1.build产物精简为dist一个文件夹
2.trace模块引入错误隔离功能
3.uglify压缩打包
v1.0.1
1.项目初始化
2.新增配置开关,trace监控功能提交
3.引入roolup
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago