快速开始
快速开始
Client Resource Dashboard 让客户在 WHMCS 客户端区域看到主机服务的实时资源使用（磁盘 / 带宽 / CPU / 内存），主机商无需自行抓取面板数据，插件已支持 cPanel / Plesk / DirectAdmin。本指南覆盖安装、首次抓取数据、Pro 端 alerts / heatmap。
适用对象：WHMCS 主机商，需要给客户呈现资源使用透明度。
1. 安装与启用
- 下载与 PHP 版本匹配的 ZIP（如
client_resource_dashboard_v1.x.x_php8.1.zip）解压到 WHMCS 根目录。 - WHMCS 后台：Setup → Apps & Integrations → Client Resource Dashboard → Activate。
- Configuration → Addon Modules → Client Resource Dashboard → 勾选允许访问的 admin 角色（推荐 Full Administrator）+ 粘贴 license key（仅 Pro 功能需要）+ 保存。
- 顶部菜单 Addons → Client Resource Dashboard 进入控制台。
激活后插件创建 mod_crd_cache / mod_crd_alert_log 等表用于缓存资源数据。
2. 仪表盘
仪表盘看到：
- 已监控服务数（缓存命中数）
- 24 小时内告警数
- 最近 10 条告警记录
- 功能矩阵（Free vs Pro）
3. 数据抓取
Cron job 每 15 分钟（可配置）通过 cPanel/Plesk/DirectAdmin API 抓取每个 hosting 服务的当前资源使用： - 磁盘已用 / 总量 - 带宽已用 / 总量（按月） - CPU / 内存（如面板支持）
数据缓存在 mod_crd_cache 表，客户区 widget 直接从缓存读取（不阻塞客户页面）。
4. 客户区呈现
任意 WHMCS 客户登录后访问「我的服务」详情页，自动看到资源面板：
- 4 个进度条（磁盘 / 带宽 / CPU / 内存）
- 颜色阈值：< 60% 绿 / 60-80% 黄 / > 80% 红
- 「升级套餐」按钮（在 80%+ 时高亮显示）
5. 热力图（Pro）
「热力图」（Heatmap）页：
- 按服务器分组的资源占用 grid
- 每个 cell = 1 个 hosting 账户，颜色按使用率热度
- 鼠标 hover 看详细数字
- 一眼定位"高耗用客户"
6. 告警规则（Pro）
「设置」页 → 告警阈值：
- 默认 80% / 90% / 95% 三档
- 触发条件：连续 N 次抓取超阈值才通知（避免毛刺）
- 通知渠道：邮件（Pro 可选 webhook）
每条告警记录在 mod_crd_alert_log，仪表盘看「最近告警」。
7. 设置（Pro）
「设置」页：
- Cron 频率（默认 15 分钟，最低 5 分钟）
- 告警阈值
- 数据保留天数（Free 7 天 / Pro 90 天）
- 通知渠道凭据
8. 自动更新
填好 license 后右侧「检查更新」面板拉取最新版本号；点「安装更新」走 WHMCS 标准更新流程。
9. 常见问题
Q：免费版能用什么？ A：单服务器 + 仪表盘 + 客户端 widget + 7 天数据保留。Heatmap、告警规则、按服务器多面板需 Pro。
Q：支持哪些控制面板？ A：cPanel（WHM API）、Plesk（REST API）、DirectAdmin。其他面板可通过自定义 hook 扩展。
Q：抓取频率太高会不会被面板限流？ A：默认 15 分钟，按需调整。每次抓取是单服务器单 API 调用，cPanel WHM 默认限流是 100 req/min，远超本插件需求。
Q：客户端 widget 是否影响 WHMCS 客户区性能？ A：客户端 widget 直接读 mod_crd_cache 表（已索引），不调用任何远程 API，毫秒级。
更多深入文档（每个面板的 API endpoint、缓存策略、数据库表）见商城内的「完整文档」。