Skip to content

快速开始 ​

十分钟内把系统跑起来并接入你的第一个应用。

1. 启动服务 ​

bash
pnpm install
pnpm db:up          # 启动 ClickHouse
pnpm build          # 构建 SDK 包
pnpm dev:server     # 服务端 :3001
pnpm dev:admin      # 管理后台 :5173

2. 登录管理后台 ​

打开 http://localhost:5173,用内置超管登录:

  • 用户名:admin
  • 密码:Admin@123456(开发环境默认;生产环境见部署-初始密码)

登录后先到右上角用户名 → 修改密码。

3. 创建应用 ​

进入「设置 → 应用」:

  1. 填写 appId(如 my-mall-web)和显示名
  2. 平台可留空(SDK 事件自带平台标识,自动识别)
  3. 创建后立即复制 token(只展示一次)

4. 接入 SDK ​

Web 应用:

ts
import { init } from '@ms-monitor/web';

init({
  appId: 'my-mall-web',
  token: '创建应用时返回的 token', // 必填,缺失/错误时服务端返回 403
  dsn: 'https://monitor.example.com/api/v1/collect',
  release: '1.0.0',
});

详见 Web 接入 / 小程序接入。

5. 看到数据 ​

触发几个页面访问和错误,回到控制台:

  • 「错误」:错误列表 → 点进详情看还原堆栈和行为轨迹
  • 「性能」:Web Vitals 评级卡与趋势
  • 「行为」:PV/UV 趋势与受众画像
  • 「告警」:预置模板库(8 条,应用无关)一键实例化到任意应用,或自建规则
  • 「报表」:导出第一份 CSV

演示数据 ​

想先看看系统满数据的样子?跑一下种子脚本:

bash
# 需要超管密码环境变量(脚本要用它登录创建应用)
MONITOR_ADMIN_PASSWORD=Admin@123456 node scripts/seed-demo.mjs

它会创建一个「示例商城」应用并灌入 30 天的演示数据。