快速入門
快速入門
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、快取策略、資料庫表）見商城內的「完整文件」。