@easyv/monitor-sdk
v1.0.10
Published
前端监控 sdk
Maintainers
Keywords
Readme
easyv-monitor-sdk
前端监控 SDK(采集)+ Node 后端落库 + 可视化看板。
看板怎么跑起来
看板是独立子项目,需要同时起一个监控后端(否则页面无数据或请求失败)。
1. 安装依赖
cd dashboard
npm install根目录若尚未安装后端依赖:
cd .. # 回到仓库根目录
npm install2. 启动监控后端(另开一个终端)
在仓库根目录执行:
npm run server默认监听 8080(可用环境变量 PORT 修改)。需本地 PostgreSQL(默认库名 easyv_monitor),数据库与鉴权见 backend/README.md。本地配置可复制 .env.example 为 .env(如 DB_USER=你的系统用户名)。
3. 启动看板
cd dashboard
npm run dev浏览器访问:http://localhost:3000(端口由 dashboard/package.json 中 vite --port 3000 决定)。
4. 看板页面配置
- 后端地址:默认
http://localhost:8080;若改了后端端口,这里改成一致。 - Bearer Token:需与后端环境变量
REPORT_TOKEN一致(开发默认见backend/README.md)。
说明
- 仓库根目录的
npm run dev是 SDK 的 Rollup 开发构建,不是看板;看板必须在dashboard目录执行npm run dev。 - 端口冲突时,可修改
dashboard/package.json里scripts.dev的--port,或释放本机占用端口。
SDK 构建
npm run build产物在 dist/(monitor.js / monitor.esm.js / monitor.cjs.js)。
更多文档
- 后端接口与环境变量:backend/README.md
- 页面上下文与热力图接入:docs/PAGE_CONTEXT_HEATMAP.md
- 前后端技术方案(详尽):docs/TECHNICAL_DESIGN_FULLSTACK.md
