https://github.com/cloudr-f2e/monitor
👀 一款轻量级的收集页面的用户点击行为、路由跳转、接口报错、代码报错、页面性能并上报服务端的SDK
https://github.com/cloudr-f2e/monitor
mini-monitor performance sdk web-monitor wx-performance
Last synced: 27 days ago
JSON representation
👀 一款轻量级的收集页面的用户点击行为、路由跳转、接口报错、代码报错、页面性能并上报服务端的SDK
- Host: GitHub
- URL: https://github.com/cloudr-f2e/monitor
- Owner: clouDr-f2e
- License: mit
- Created: 2020-07-20T10:42:43.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-13T06:57:59.000Z (12 months ago)
- Last Synced: 2025-04-07T04:11:12.275Z (about 1 month ago)
- Topics: mini-monitor, performance, sdk, web-monitor, wx-performance
- Language: TypeScript
- Homepage: https://cloudr-f2e.github.io/monitor-demo/#/
- Size: 19.3 MB
- Stars: 1,897
- Watchers: 21
- Forks: 320
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
一款轻量级的收集页面的用户点击行为、路由跳转、接口报错、代码报错、并上报服务端的SDK
[](https://www.npmjs.com/package/@zyf2e/monitor-web)
[](https://github.com/clouDr-f2e/mitojs/blob/dev/LICENSE)
[](https://github.com/prettier/prettier)
[](https://github.com/clouDr-f2e/monitor/commits/master)
[](https://travis-ci.com/github/clouDr-f2e/monitor)
[](https://codecov.io/gh/clouDr-f2e/monitor)
## 功能
- [x] 🔨监听请求错误
- [x] 🔨console
- [x] 🔨路由跳转
- [x] 🔨代码报错
- [x] 🔨click、wx:tab、touchmove
- [x] 🔨资源加载错误
- [x] 🏅自定义上报错误
- [x] 🚀丰富的hooks与配置项支持可高定制化
- [x] 🌝支持IE8和安卓5以上
- [x] 👌持续迭代与更新
- [x] 完善的浏览器e2e和微信小程序e2e
- [x] 完善的单元测试（77%~coding）
- [x] 支持原生Web [@zyf2e/monitor-browser](https://github.com/clouDr-f2e/mitojs/tree/master/packages/browser)
- [x] 支持Web框架（Vue3、Vue2、React@Next） [@zyf2e/monitor-web](https://github.com/clouDr-f2e/mitojs/tree/master/packages/web)
- [x] 支持原生微信小程序、支持uni-app等微信小程序框架 [@zyf2e/monitor-wx-mini](https://github.com/clouDr-f2e/mitojs/tree/master/packages/wx-mini)
- [x] 支持Web性能监控 [@zyf2e/monitor-web-performance](https://github.com/clouDr-f2e/mitojs/tree/master/packages/web-performance)
- [x] 支持微信小程序性能监控 [@zyf2e/monitor-wx-mini-performance](https://github.com/clouDr-f2e/mitojs/tree/master/packages/wx-mini-performance)
## 安装
### web
#### 使用npm
```bash
$ npm i @zyf2e/monitor-web
```
### 使用yarn
```bash
$ yarn add @zyf2e/monitor-web
```
### web-performance
```bash
$ npm i @zyf2e/monitor-web-performance
```
### 使用yarn
```bash
$ yarn add @zyf2e/monitor-web-performance
```
### wx-mini
#### 使用npm
```bash
$ npm i @zyf2e/monitor-wx-mini
```
### 使用yarn
```bash
$ yarn add @zyf2e/monitor-wx-mini
```
## 使用指南
[使用指南](https://github.com/clouDr-f2e/mitojs/blob/master/docs/guide.md)
* [vue接入指南](https://github.com/clouDr-f2e/mitojs/blob/master/docs/guide.md#Vue)
* [react接入指南](https://github.com/clouDr-f2e/mitojs/blob/master/docs/guide.md#react)
* [wx-mini接入指南](https://github.com/clouDr-f2e/mitojs/blob/master/docs/guide.md#微信小程序)
* [performance接入指南](https://github.com/clouDr-f2e/mitojs/blob/dev/docs/performance.md)
* [wx-mini-performance接入指南](https://github.com/clouDr-f2e/mitojs/blob/dev/docs/wx-mini-performance.md)
## hooks与配置项
[hooks与配置项](https://github.com/clouDr-f2e/mitojs/blob/master/docs/option.md)
### 示例
[monitor-在线demo](https://cloudr-f2e.github.io/monitor-demo/#/)
## 收集信息平台展示
**该SDK能收集哪些信息：下面这些例子给你一一展示：**
[vue-在线示例](https://static.91jkys.com/f2e/mito-error-example/#/errors/1/info)
[react-在线示例](https://static.91jkys.com/f2e/mito-error-example/#/errors/2/info)
[js-在线示例](https://static.91jkys.com/f2e/mito-error-example/#/errors/3/info)
[wx-mini-在线示例](https://static.91jkys.com/f2e/mito-error-example/#/errors/4/info)