0.0.4 • Published 2 years ago

hx-monitor v0.0.4

Weekly downloads
4
License
ISC
Repository
-
Last release
2 years ago

HXMonitor SDK

HXMonitor SDK是一个浏览器性能信息,错误信息上报SDK

使用方式

  • 浏览器直接使用

1.下载 dist/hx-monitor 到本地

2.使用script标签引入到html的头部(备注:放到所有js资源之前)

3.使用HXMonitor函数进行数据的监听上报

<html>
<head>
  <meta charset="UTF-8">
  <title>performance test</title>
  <script src="../dist/hx-monitor"></script>
  <script>
    HXMonitor({
        appkey: 'appkey', //Your appkey
    })
  </script>
</head>
  • webpack使用

1.下载

  cnpm install hx-monitor -S

2.import HXMonitor from 'hx-monitor'

import HXMonitor from 'hx-monitor'

HXMonitor({
        appkey: 'appkey', //Your appkey
})
  • 对外方法addError()
  1. Use vue
// in main.js 
import HXMonitor from 'hx-monitor'

HXMonitor({
        appkey: 'appkey', //Your appkey
})
// 使用此方法后vue的错误将不会在控制台打印
Vue.config.errorHandler = function (err, vm, info) {
   console.error(err) // 为方便调试
   HXMonitor.addError('vue',err)
}
  1. Use react
// in index.js
import HXMonitor from 'hx-monitor'

HXMonitor({
        appkey: 'appkey', //Your appkey
})

class ErrorBoundary extends React.Component {
  constructor(props) {
    super(props);
    this.state = { hasError: false };
  }

  componentDidCatch(err, info) {
    this.setState({ hasError: true });
    // 将component中的报错发送到HXMonitor
    HXMonitor.addError('react',err)
  }

  render() {
    if (this.state.hasError) {
      return null;
      // Note: 也可以在出错的component处展示出错信息,返回自定义的结果。
    }
    return this.props.children;
  }
}

ReactDOM.render( < ErrorBoundary > < App / > < /ErrorBoundary>, document.getElementById('root'));
  • 参数说明
参数说明是否必填默认值备注
appkey申请的appkey需从监控平台添加项目,并获取appkey
reportURL数据上报的地址http://localhost:3000
_isError是否监控前端错误true
_isPerformance是否上报页面性能true
_isFilterUrl是否过滤本地的url(本地调试环境)true
filterUrl接上条,过滤的主机名列表'','localhost'''是本地直接打开的主机名,'localhost'是本地服务主机名
_isAjax是否上报ajax错误true
_isAxios是否上报axios错误false
_isChectAjaxStatus是否上报成功接口非正常状态false上传的是接口成功后状态不对的接口,和ajaxChectStatus配合使用
ajaxChectStatus上传上报成功接口非正常状态的条件[]传2个值。如 'code',200
0.0.3

2 years ago

0.0.4

2 years ago

0.0.2

3 years ago

0.0.1

3 years ago

1.0.2

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago