1. 概述
1.1 版本
報表伺服器版本 | 系統維運插件版本 | 功能變更 |
---|---|---|
11.0 | V1.0 | - |
11.0.3 | V1.0 | 新增支援一鍵配置檢查項的值 |
11.0.7 | V1.3.1 | 新增部分健康巡檢內容 支援生成並下載巡檢報表 |
1.2 應用場景
如果記憶體環境配置不合理,非常容易導致報表系統當機,且此類當機情況很難復現,排查困難。
1.3 功能簡介
FineReport11.0 中內建了系統維運插件,直接擁有此功能。
「健康巡檢」,可幫助使用者檢查系統中的各項配置是否合理,以輔助使用者優化環境配置,更好地防止當機情況的發生。
使用者手動檢查/平台定期檢查報表系統各項環境配置是否合理
當系統環境配置不合理時,派送訊息給使用者
為使用者提供系統環境配置的合理改進指導
本文將簡單介紹健康巡檢功能的檢查邏輯和檢查項。
2. 系統檢查項
V1.3.1之前版本的插件,僅支援環境配置檢查。
V1.3.1及之後版本的插件,支援進行的巡檢內容,包括系統檢查、系統運作狀態、埠檢查、網路檢查、服務聯通性檢查、業務檢查、環境檢查、磁碟檢查、非容器化部署檢查、虛擬機檢查。如下表所示:
詳情請參見:維運監視指導手冊 第三章。
巡檢內容 | 檢查項 |
---|---|
系統檢查 | 僅匯出資訊,不進行配置推薦,檢查項包括: 工件系統資訊、glibc/gcc版本、hostname、時區資訊、CPU主頻、核心數、記憶體大小、已使用記憶體、閒置記憶體、交換分割槽、檢查時間、根目錄磁碟、根目錄磁碟剩餘 |
系統運作狀態 |
|
埠檢查 |
|
網路檢查 | 檢查檔案伺服器、外接資料庫、狀態伺服器和應用之間通訊是否正常,是否能夠ping通,是否存在丟包情況 |
服務聯通性檢查 | 檢查工程與Redis組件、Sftp組件、FineDB資料庫之間是否聯通 |
業務檢查 |
|
環境檢查 |
|
磁碟檢查 | 僅匯出資訊,不進行配置推薦,檢查項包括: 磁碟空間、已使用磁碟空間、閒置磁碟空間、順序讀取、順序寫、隨機讀、小檔案建立、小檔案刪除 |
非容器化部署 | 僅匯出資訊,不進行配置推薦,檢查項包括: 進程使用者、伺服器主要資料夾權限 |
虛擬機檢查 |
|
檢查後存在問題的檢查項,會在頁面中展示,如下圖所示:
3. 一鍵配置
11.0.3 及之後版本,支援一鍵配置健康巡檢建議值。
3.1 不支援的環境
對於以下環境,不支援一鍵配置功能:
1)非 Tomcat 部署環境,不支援一鍵配置健康巡檢建議值,例如was部署、weblogic部署等。
2)工程系統中若存在自行設定的 setenv 檔案,不支援一鍵配置健康巡檢建議值。
3)服務形式啟動的 Tomcat 工程,不支援一鍵配置健康巡檢建議值。
4)Windows環境下 exe 啟動的 Tomcat 工程,不支援一鍵配置健康巡檢建議值。
5)設計器環境下的 FineReport 工程,不支援一鍵配置健康巡檢建議值。
6)系統物理記憶體為 16 GB及以下的環境,不支援一鍵配置健康巡檢建議值。
3.2 配置方法
若當前工程環境滿足一鍵配置的要求,且存在需要一鍵配置的檢查項,在「健康巡檢」頁面左上角出現按鈕「查看建議配置」。
點選「查看建議配置」,即可勾選需要配置的檢查項,點選「應用配置」,即可一鍵配置異常項的值。配置成功後,跳出提示「應用配置成功,重啟伺服器後生效」。
報表工程重啟後,可以發現剛剛的異常項均已成功配置。
注1:支援一鍵配置的檢查項為:堆內記憶體、堆外NIO記憶體、堆外FineIO記憶體、垃圾回收器型別、老年代與新生代比例、棧空間。
注2:若沒有檔案讀寫權限或者無法修改配置檔案時,提示「應用配置失敗:沒有配置檔案讀寫權限」,點選「確定」,則修改失敗,傳回健康巡檢介面。
4. 巡檢報表
每一次健康巡檢結束後,會生成一個巡檢報表。使用者可將報表下載到本地,或線上預覽。如下圖所示:
報表內容包括上述所有檢查項。報表範例如下圖所示:
5. 觸發檢查
5.1 手動檢查
系統重啟後,每小時獲取一次系統的配置情況。
第一次進行健康巡檢時,需要點選「開始巡檢」按鈕,系統自動進行檢查,獲取最近一次的系統配置,更新檢查結果。
再次進行進行健康巡檢時,點選「重新診斷」按鈕,系統自動進行檢查,獲取最近一次的系統配置,更新檢查結果。
5.2 自動檢查
在「健康巡檢處理」頁面,管理者可開啟「系統自動檢查」並儲存。
開啟後,系統在每週日上午 11 點進行自動檢查,存在不合理配置時可透過簡訊提醒、平台訊息、郵件提醒三種形式通知管理者。
注:
1)簡訊提醒:需要開啟簡訊平台,詳細點選 簡訊
2)郵件提醒:需要配置郵件伺服器,詳細點選 郵箱
3)平台訊息:需要在負載均衡層面配置websocket埠並且開放,相關文檔:Websocket埠被佔用/無法使用
6. 維運工具
維運API金鑰,是在「維運平台」中綁定當前工程的API金鑰,詳情請參見:維運平台產品簡介
7. 注意事項
7.1 快速修復異常
問題描述:
使用健康巡檢的「快速修復」功能,修改了tomcat記憶體後,使用./startup.sh命令啟動工程,tomcat 閃退,並且無 tomcat 進程出現。
原因分析:
系統記憶體不足。
解決方案:
刪除%TOMCAT_HOME%/bin下的setenv.sh檔案,該檔案為快速修復時生成的配置檔案。
7.2 This combination of host and port requires TLS
問題描述:
健康巡檢全部失敗。
觸發巡檢並開啟日誌info級別,出現報錯:This combination of host and port requires TLS
原因分析:
埠沒有配置好https
解決方案:
finedb的 fine_conf_entity 表中,需要新增一個欄位ClusterNodeConfig.useHttps,欄位值為true
新增方法請參見:填報修改fine_conf_entity