SHM (Self-Hosted Metrics) 让您在不侵犯用户隐私的情况下，收集自托管软件的使用统计数据，了解活跃实例数量和功能使用情况。 ## 核心功能 - 🔐 **Ed25519 加密身份** - 每个实例生成唯一密钥对，防止数据伪造 - 📦 **多应用支持** - 单个 SHM 服务器可追踪多个软件产品 - 🎨 **动态仪表盘** - 自动适应您发送的任何 JSON 数据结构 - ⚙️ **业务/系统指标分离** - 自动区分业务 KPI 和系统资源数据 ## 1. 访问仪表盘 打开浏览器访问您的 SHM 地址（如 `https://shm.your-domain.com`），仪表盘会自动显示已注册的应用和实例。 ### 2. 集成 SDK 可参考https://github.com/btouchard/shm 中 Readme 文档 在您的自托管应用中集成 SHM SDK，开始收集遥测数据。 #### Node.js SDK 集成举例 ```bash npm install @btouchard/shm-sdk ``` ```typescript import { SHMClient } from '@btouchard/shm-sdk'; const telemetry = new SHMClient({ serverUrl: 'https://shm.your-domain.com', appName: 'MyApp', appVersion: '1.0.0', environment: 'production', enabled: true, }); // 定义业务指标 telemetry.setProvider(() => ({ users_active: countActiveUsers(), documents_created: countDocuments(), })); // 启动（返回 AbortController） const controller = telemetry.start(); ``` --- ## 查看数据 ### 仪表盘界面 | 区域 | 说明 | |------|------| | **应用列表** | 左侧显示所有注册的应用 | | **KPI 卡片** | 顶部展示业务指标汇总 | | **实例表格** | 显示每个实例的详细信息 | | **趋势图表** | 可视化指标变化趋势 | ### 数据说明 - **Business Metrics**: 您通过 `SetProvider` 定义的业务指标 - **System Metrics**: SDK 自动采集的系统信息（CPU、内存、OS 等） - **Instance ID**: 每个实例的唯一加密身份
