error-monitor-sdk
v1.0.1
Published
A lightweight front-end error monitoring SDK
Maintainers
Readme
Error Monitor SDK
一个轻量级的前端错误监控 SDK,可以捕获 JavaScript 错误、Promise 异常、网络请求错误以及资源加载错误。
功能特性
- JavaScript 错误监控: 捕获未捕获的 JavaScript 错误 (
window.onerror)。 - Promise 异常监控: 捕获未处理的 Promise 拒绝 (
window.onunhandledrejection)。 - 网络错误监控:
- 拦截并监控
XMLHttpRequest错误。 - 拦截并监控
fetchAPI 错误。
- 拦截并监控
- 资源加载错误监控: 捕获资源(如图片
<img>和脚本<script>)加载失败的错误。 - 数据上报: 优先使用
navigator.sendBeacon进行可靠的数据上报,如果不支持则降级使用fetch。
安装
npm install error-monitor-sdk使用方法
在你的应用入口文件(例如 main.js 或 App.tsx)中初始化 SDK。
import { initErrorMonitor } from 'error-monitor-sdk';
initErrorMonitor({
reportUrl: 'https://your-monitoring-server.com/api/report', // 你的错误上报接口地址
projectName: 'my-awesome-project', // 项目名称
environment: 'production', // 当前环境,如 'development', 'staging', 'production' 等
});配置项
initErrorMonitor 函数接受一个配置对象,包含以下属性:
| 属性名 | 类型 | 说明 |
| ------------- | -------- | ------------------------------------------------------------ |
| reportUrl | string | 必填。错误数据将通过 POST 请求发送到的 URL 地址。 |
| projectName | string | 必填。用于标识错误来源的项目名称。 |
| environment | string | 必填。当前运行环境(例如 'production', 'development')。 |
本地开发
克隆仓库
git clone https://github.com/your-username/error-monitor.git cd error-monitor安装依赖
npm install运行开发服务器
npm run dev构建生产版本
npm run build运行演示 Demo 启动本地服务器以测试 SDK 功能。
npm run demo然后在浏览器中打开
http://localhost:3000(或控制台显示的端口)查看演示。
许可证
MIT
