https://github.com/wuba/mp-monitor
mp-monitor脱胎于58内部前端质量监控系统“北斗”。致力于为小程序异常采集和性能统计分析提供采集方案和统一的数据指标，适配多端小程序（微信，头条，支付宝，百度，QQ，360，JD）。 如果开发者想要在自己的项目中快速搭建小程序的异常采集和性能监控数据分析。mp-monitor将能帮助用户快速采集到相关的数据用于分析和监控。
https://github.com/wuba/mp-monitor
Last synced: 5 months ago
JSON representation
mp-monitor脱胎于58内部前端质量监控系统“北斗”。致力于为小程序异常采集和性能统计分析提供采集方案和统一的数据指标，适配多端小程序（微信，头条，支付宝，百度，QQ，360，JD）。 如果开发者想要在自己的项目中快速搭建小程序的异常采集和性能监控数据分析。mp-monitor将能帮助用户快速采集到相关的数据用于分析和监控。
- Host: GitHub
- URL: https://github.com/wuba/mp-monitor
- Owner: wuba
- License: mit
- Created: 2021-11-05T08:18:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-17T08:02:47.000Z (over 3 years ago)
- Last Synced: 2025-04-29T22:39:13.510Z (5 months ago)
- Language: TypeScript
- Size: 444 KB
- Stars: 68
- Watchers: 9
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 小程序监控sdk
小程序监控sdk（异常日志、性能日志、行为轨迹日志）
## 使用
1. npm形式使用
```js
npm i @mpapp/monitor --save
const mpMonitor = require('@mpapp/monitor');
mpMonitor.init({
projectId: '',
url: '', // 异常上报接口
isDebug: true, // 默认关闭 开启后控制台打印日志；不触发上报接口
reportBreadcrumb: true, // 是否开启行为轨迹日志采集(默认false)
});
```
2. 单文件形式使用
> 原生小程序开发，建议将 mp_monitor 包dist目录下 [mp_monitor.min.js](https://github.com/BubbleM/mp_monitor/blob/main/dist/mp_monitor.min.js) 拷贝到项目目录下直接使用
```js
const mpMonitor = require('./utils/mp-monitor');
mpMonitor.init({
projectId: '',
url: ''
});
```
### 后台配置
使用需要在后台将接口上报域名 **url** 配置到 request合法域名 中
## 参数描述
- projectId: 项目标识
- url: 异常日志上报接口地址
- isDebug: 默认关闭 开启后控制台打印日志；不触发上报接口
- reportBreadcrumb: 是否开启行为轨迹日志采集 默认false
### 特性
- 采集request处理异常
- 采集console全局异常
- 采集资源文件下载异常
- 采集小程序页面维度性能数据
- 记录客户端基本信息（系统信息、用户信息、网络信息、场景信息）
- 支持微信、百度、头条、支付宝、QQ、360等多端异常采集
- 采集用户行为轨迹
支持用户自定义上报行为轨迹 wx.reportBreadcrumb()