jsdoc 自动生成文档

commit规则

• feat 新特性、新功能
• fix 修改bug
• docs 文档修改
• style 代码格式修改, 注意不是 css 修改
• refactor 代码重构
• perf 优化相关，比如提升性能、体验
• test 测试用例修改
• chore 其他修改, 比如改变构建流程、或者增加依赖库、工具等
• revert 回滚到上一个版本
• build 编译相关的修改，例如发布版本、对项目构建或者依赖的改动

安装

 npm i lz-monitor-sdk

配置

在main.js中导入并创建monitorSDK实例,实例参数

• reportUrl 上报地址
• appName 项目名称
• httpWhiteList http请求白名单
• errorConfig 错误信息配置
  • isJsError (是否开启js错误监控)
  • isPromiseError (是否开启Promise错误监控)
  • isResourceError (是否开启静态资源错误监控)
• isHttpRequest http请求白名单 (是否开启HTTP请求监控)
• isPerformanceCollect 是否开启性能监控

import monitorSDK from 'lz-monitor-sdk'
const monitor = new monitorSDK({
  reportUrl: 'http://localhost:3000/addLog',
  appName: 'H5',
  httpWhiteList: ['maidian/log'],
  errorConfig:{
    isJsError: true,
    isPromiseError: true,
    isResourceError: true
  },
  isPerformanceCollect:true,
  isHttpRequest:true
})

方法

• updateBaseConfig 更新上报数据
• loadErrorConfig 错误监控配置加载
• loadPerformanceConfig 性能监控配置加载
• loadHttpConfig http请求数据配置加载

monitor.updateBaseConfig()

监控API

• errorTracker 错误信息上报
• httpTracker 接口请求信息上报
• performanceTracker 性能监控信息上报