可視化控制臺部署
可視化控制臺部署
可視化控制臺是IoTDB配套工具之一（類似 Navicat for MySQL）。它用于數據庫部署實施、運維管理、應用開發各階段的官方應用工具體系，讓數據庫的使用、運維和管理更加簡單、高效，真正實現數據庫低成本的管理和運維。本文檔將幫助您安裝Workbench。
可視化控制臺工具的使用說明可參考文檔 使用說明 章節。
1. 安裝準備
| 準備內容 | 名稱 | 版本要求 | 官方鏈接 |
|---|---|---|---|
| 操作系統 | Windows或Linux | - | - |
| 安裝環境 | JDK | 1.5.4及以下版本需要 >= 1.8，1.5.5及以上版本需要 >= 17（下載時請根據機器配置選擇ARM或x64安裝包） | https://www.oracle.com/java/technologies/downloads/ |
| 相關軟件 | Prometheus | 需要 >=V2.30.3 | https://prometheus.io/download/ |
| 數據庫 | IoTDB | 需要>=V1.2.0企業版 | 您可聯系商務或技術支持獲取 |
| 控制臺 | IoTDB-Workbench-<version> | - | 您可根據附錄版本對照表進行選擇后聯系商務或技術支持獲取 |
1.1 前置檢查
為確保您獲取的可視化控制臺安裝包完整且正確，在執行安裝部署前建議您進行SHA512校驗。
準備工作：
- 獲取官方發布的 SHA512 校驗碼：聯系天謀工作人員獲取
校驗步驟（以 linux 為例）：
- 打開終端，進入安裝包所在目錄（如
/data/workbench）：cd /data/workbench - 執行以下命令計算哈希值：
sha512sum IoTDB-Workbench-`<version>`.zip - 終端輸出結果（左側為SHA512 校驗碼，右側為文件名）：
- 對比輸出結果與官方 SHA512 校驗碼，確認一致后，即可按照下方流程執行可視化控制臺的安裝部署操作。
注意事項：
- 若校驗結果不一致，請聯系天謀工作人員重新獲取安裝包
- 校驗過程中若出現"文件不存在"提示，需檢查文件路徑是否正確或安裝包是否完整下載
2. 安裝步驟
2.1 步驟一：IoTDB 開啟監控指標采集
- 打開監控配置項。IoTDB中監控有關的配置項默認是關閉的，在部署監控面板前，您需要打開相關配置項（注意開啟監控配置后需要重啟服務）。
| 配置項 | 所在配置文件 | 配置說明 |
|---|---|---|
| cn_metric_reporter_list | conf/iotdb-system.properties | 請在配置文件中添加該配置項，值設置為PROMETHEUS |
| cn_metric_level | 請在配置文件中添加該配置項，值設置為IMPORTANT | |
| cn_metric_prometheus_reporter_port | 請在配置文件中添加該配置項，可保持默認設置9091，如設置其他端口，不與其他端口沖突即可 | |
| dn_metric_reporter_list | conf/iotdb-system.properties | 請在配置文件中添加該配置項，值設置為PROMETHEUS |
| dn_metric_level | 請在配置文件中添加該配置項，值設置為IMPORTANT | |
| dn_metric_prometheus_reporter_port | 請在配置文件中添加該配置項，可保持默認設置9092，如設置其他端口，不與其他端口沖突即可 | |
| dn_metric_internal_reporter_type | 請在配置文件中添加該配置項，值設置為IOTDB | |
| enable_audit_log | conf/iotdb-system.properties | 請在配置文件中添加該配置項，值設置為true |
| audit_log_storage | 請在配置文件中添加該配置項，值設置為IOTDB,LOGGER | |
| audit_log_operation | 請在配置文件中添加該配置項，值設置為DML,DDL,QUERY |
重啟所有節點。修改3個節點的監控指標配置后，可重新啟動所有節點的confignode和datanode服務：
./sbin/stop-standalone.sh #先停止confignode和datanode ./sbin/start-confignode.sh -d #啟動confignode ./sbin/start-datanode.sh -d #啟動datanode重啟后，通過客戶端確認各節點的運行狀態，若狀態都為Running，則為配置成功：
2.2 步驟二：安裝、配置Prometheus監控
確保Prometheus安裝完成(官方安裝說明可參考：https://prometheus.io/docs/introduction/first_steps/)
解壓安裝包，進入解壓后的文件夾：
tar xvfz prometheus-*.tar.gz cd prometheus-*修改配置。修改配置文件prometheus.yml如下
- 新增confignode任務收集ConfigNode的監控數據
- 新增datanode任務收集DataNode的監控數據
global: scrape_interval: 15s evaluation_interval: 15s scrape_configs: - job_name: "prometheus" static_configs: - targets: ["localhost:9090"] - job_name: "confignode" static_configs: - targets: ["iotdb-1:9091","iotdb-2:9091","iotdb-3:9091"] honor_labels: true - job_name: "datanode" static_configs: - targets: ["iotdb-1:9092","iotdb-2:9092","iotdb-3:9092"] honor_labels: true啟動Prometheus。Prometheus 監控數據的默認過期時間為15天，在生產環境中，建議將其調整為180天以上，以對更長時間的歷史監控數據進行追蹤，啟動命令如下所示：
./prometheus --config.file=prometheus.yml --storage.tsdb.retention.time=180d確認啟動成功。在瀏覽器中輸入
http://IP:port，進入Prometheus，點擊進入Status下的Target界面，當看到State均為Up時表示配置成功并已經聯通。
2.3 步驟三：安裝Workbench
進入iotdb-Workbench-
<version>的config目錄修改Workbench配置文件：進入
config文件夾下修改配置文件application-prod.properties。若您是在本機安裝則無需修改，若是部署在服務器上則需修改IP地址Workbench可以部署在本地或者云服務器，只要能與 IoTDB 連接即可
配置項 修改前 修改后 pipe.callbackUrl pipe.callbackUrl= http://127.0.0.1pipe.callbackUrl= http://<部署Workbench的IP地址>
啟動程序：請在IoTDB-Workbench-
<version>的sbin文件夾下執行啟動命令Windows版：
# 后臺啟動Workbench start.bat -dLinux版：
# 后臺啟動Workbench ./start.sh -d可以通過
jps命令進行啟動是否成功，如圖所示即為啟動成功：
驗證是否成功：瀏覽器中打開:"
http://服務器ip:配置文件中端口"進行訪問，例如:"http://127.0.0.1:9190"，當出現登錄界面時即為成功
3. 附錄：IoTDB與控制臺版本對照表
| 控制臺版本號 | 版本說明 | 可支持IoTDB版本 |
|---|---|---|
| V2.0.1-beta | V2.x系列首個版本，支持樹、表雙模型 | V2.0 及以上版本，AI分析模塊僅支持2.0.5以上版本 |
| V1.5.7 | 優化測點列表中測點名稱拆分為設備名稱和測點，測點選擇區域支持左右滾動，以及導出文件列順序與頁面保持一致 | V1.3.4及以上的1.x系列版本 |
| V1.5.6 | 優化 CSV 格式導入導出功能：導入時，支持標簽、別名為非必填項；導出時，支持測點描述里反引號包裹引號的場景 | V1.3.4及以上的1.x系列版本 |
| V1.5.5 | 新增服務器時鐘，支持企業版激活數據庫 | V1.3.4及以上的1.x系列版本 |
| V1.5.4 | 新增實例管理中prometheus設置的認證功能 | V1.3.4及以上的1.x系列版本 |
| V1.5.1 | 新增AI分析功能以及模式匹配功能 | V1.3.2及以上的1.x系列版本 |
| V1.4.0 | 新增樹模型展示及英文版 | V1.3.2及以上的1.x系列版本 |
| V1.3.1 | 分析功能新增分析方式，優化導入模版等功能 | V1.3.2及以上的1.x系列版本 |
| V1.3.0 | 新增數據庫配置功能，優化部分版本細節 | V1.3.2及以上的1.x系列版本 |
| V1.2.6 | 優化各模塊權限控制功能 | V1.3.1及以上的1.x系列版本 |
| V1.2.5 | 可視化功能新增“常用模版”概念，所有界面優化補充頁面緩存等功能 | V1.3.0及以上的1.x系列版本 |
| V1.2.4 | 計算功能新增“導入、導出”功能，測點列表新增“時間對齊”字段 | V1.2.2及以上的1.x系列版本 |
| V1.2.3 | 首頁新增“激活詳情”，新增分析等功能 | V1.2.2及以上的1.x系列版本 |
| V1.2.2 | 優化“測點描述”展示內容等功能 | V1.2.2及以上的1.x系列版本 |
| V1.2.1 | 數據同步界面新增“監控面板”，優化Prometheus提示信息 | V1.2.2及以上的1.x系列版本 |
| V1.2.0 | 全新Workbench版本升級 | V1.2.0及以上的1.x系列版本 |