1. 概述
1.1 版本
| FineReport 版本 | JAR 包 | 安裝包 | 運行環境 |
|---|---|---|---|
| 10.0 | 2020-04-26 | 系統可用性檢測工具安裝包 | Windows 和 Linux 系統 JDK1.8 |
| 2020-08-03 |
1.2 應用場景
系統可用性監測工具能提供監控節點健康狀态并進行日志記錄的功能，但有時用戶在工程全部宕機後需要收到平台的異常通知。
1.3 功能簡介
增加配置郵件服務器，以及基於郵件服務器的通知功能，通過配置郵件服務器實現工程異常狀态通知，并允許定義收件人、通知内容、通知頻率。
2. Linux 環境安裝使用
2.1 安裝檢測工具
java -version # 依賴Java環境，檢測依賴環境
下載安裝包并将其放到/usr目錄下，解壓并爲其配置可執行權限，命令如下所示：
cd /usr #進入/usr目錄
unzip cluster-check-2.0-SNAPSHOT.zip -d usableTool #解壓安裝包到usableTool文件夾
cd /usr/usableTool #進入目錄
chmod +x *.jar *.sh #給cluster-check-2.0-SNAPSHOT、start.sh、 stop.sh、 reload.sh賦予可執行權限2.2 修改配置
在conf.properties中配置監測選項，注意該配置文件需要放在 JAR 文件的同級目錄下。
2.2.1 基礎配置
可配置項如下所示：
| 配置項 | 參數名(包括默認配置值) | 可配置值 | 說明 |
|---|---|---|---|
| 要監控的工程地址 | urls | 要監控的工程地址，需要配置集群入口和各節點入口，例如(http://crm.finereporthelp.com）或者ip+端口，以空格分隔 | |
| 默認使用健康監測地址 | defaultUri | 默認使用 /webroot/decision/system/info 作爲健康監測的地址，2019.08後的jar包可以用 /webroot/decision/system/health 作爲健康監測的地址，允許自定義健康監測地址 | |
| 請求超時時間 | timeout | ||
| 請求間隔 | period | ||
| 失敗次數 | failedTime | 失敗x次才認爲系統不可用 | |
日志等級 | logLevel | 日志等級【info|warn|debug】，默認爲 debug，會返回錯誤代碼，即系統沒有挂掉但是狀态碼不是健康狀态碼#若設置爲info，會記錄所有請求#若設置爲warn，則只記錄失敗的請求 | |
| 日志時間格式 | dateFormat | 默認爲dateFormat=yyyy-MM-dd HH:mm:ss | |
| 健康狀态碼 | expectAliveCode | 健康狀态碼，支持正則，以空格分隔 | |
| 是否開機自啓動 | startOnUp | 是否開機自啓動,需要root用戶權限，默認爲true |
2.2.2 配置郵件服務器
允許用戶配置以下内容：
| 配置項 | 參數名 | 可配置值 | 說明 |
|---|---|---|---|
| 郵件服務器 | smtp | SMTP.gmail.com SMTP.sina.com SMTP.163.com SMTP.qq.com SMTP.sohu.com SMTP.live.com SMTP.mail.yahoo.com SMTP.netease.com SMTP.sina.com.cn SMTP.263.net SMTP.126.com | 允許配置列表中的郵件服務器 |
| smtp 端口 | smtp_port | 數值 | 默認 25 |
| 加密方式 | smtp_encryption | SSL\TLS\nothing | 默認 nothing |
| 發件人地址 | sender_address | 填寫郵箱地址 | |
| 收件人地址 | recipient_address | 多個收件人以英文逗号隔開 | |
| 密碼 | password | 郵件密碼，加密顯示 注：在首次啓動時提示用戶輸入郵箱密碼，配置完成後發送一個測試郵件，若用戶需要重新配置則在配置文件裏删除此字段，再次啓動時即可提示需要配置郵箱密碼。 |
允許用戶配置通知頻率。當檢測到異常即進行通知，若應用持續異常，則下一次通知爲1h後，直到檢測到工程恢複正常則停止通知。
2.2.3 配置多個健康檢查地址
爲了能夠更精準地識别異常情況，允許用戶配置多個健康檢查接口，共用配置的 IP 和端口。
2.2.4 自定義通知内容
默認通知内容：#url# #healthurl# access failed, please check its health status。
允許用戶對通知内容進行自定義。
2.2.5 提高健康檢測頻率
當做了異常通知時，就要考慮到消息通知的及時性，因爲 5s 檢測一次時間就比較長了，如果超時就需要500s才會發通知。
調整健康檢測相關的默認參數：
timeout=10000
period=5000
failedTime=3
2.2.6 引用平台消息通知模塊
考慮到工具的穩定性和可維護性，直接引用平台消息通知模塊實現。
2.3 運行監測工具
./start.sh # 開始
./stop.sh # 結束
./reload.sh #修改配置文件後,reload即可生效
ps -ef|grep cluster-check # 查看進程 
3. Windows 環境
3.1 安裝檢測工具
下載安裝包并利用解壓工具解壓， 在conf.properties中配置監測選項
注意：Windows環境的安裝包同 Linux 一緻，并且配置項的修改内容也一緻。
3.2 運行監測工具
點擊start.bat開始，點擊stop.bat結束，修改配置文件後，點擊reload.bat生效。
查看進程：
4. 監測報告示例
在/usableTool/logs路徑下的 system.log 中查看，示例如下圖所示：
