日誌簡介

1.1 版本

1.2 功能简介

FineReport 工程运行时，会生成相关日志文件进行记录。

系統日誌記錄系統運作過程中的一些資訊。

2.1 日誌级别

系統日誌匯出級別分為五種：DEBUG、INFO、WARN、ERROR、FATAL。

日誌級別大小排序（嚴重程度）：FATAL>ERROR>WARN>INFO>DEBUG

日誌詳細程度排序：FATAL<ERROR<WARN<INFO<DEBUG

2.2 設計器端

設計器端系統日誌，記錄設計器本地工程運作時的相關日誌。

若設計器遠端連結伺服器工程，日誌並不記錄到設計器日誌中，而是記錄到伺服器端日誌中。

2.2.1 設定日誌級別&儲存位置

設計器預設日誌級別為ERROR，預設儲存在%FR_HOME%\logs\fanruan.log檔案中。

開啟設計器，點選「檔案>選項>進階」，如下圖所示：

在「log匯出配置」處可修改匯出日誌儲存位置。在「log級別設定」處可根據需求自行調整日誌級別。

2.2.2 查看系統日誌

使用者可在設計器右上角點選開啟日誌摺疊框，然後可在彈出框中查看日誌。支援設定日誌顯示型別，支援清空日誌顯示介面，支援全選日誌方便複製。

設計器日誌查看介面預設顯示全部日誌，使用者可自行選擇只顯示「警告」/「錯誤」日誌，如下圖所示：

注：日誌查看介面的清空/顯示，不會導致日誌檔案內的記錄被刪除。

2.3 伺服器端

設計器端系統日誌，記錄伺服器端工程運作時的相關日誌。

若設計器遠端連結伺服器工程，日誌並不記錄到設計器日誌中，而是記錄到伺服器端日誌中。

2.3.1 设置日誌级别

系统日志默认级别为「ERROR」。

超级管理员登录数据决策系统，点击「管理系统>智能运维>平台日志」，点击「全局设置」，可根据需求自行调整日志级别。如下图所示：

2.3.2 日誌存储位置

報表工程部署在伺服器上，例如 tomcat 伺服器，日誌儲存在%FR_HOME%\logs\fanruan.log檔案裏，Tomcat伺服器的日誌檔案catalina.out裏也會生成。

不支援修改伺服器工程日誌儲存位置，不支援自動清理%FR_HOME%\logs\fanruan.log檔案。

用升級工具升級或直接安裝 JAR 包為 2019-05-20 及之後的版本的客戶，每日 0 點定時將 fanruan.log 壓縮，用以節省磁碟空間。

透過更換 JAR 升級的客戶，可直接刪除log4j.properties檔案實現日誌檔案定時壓縮功能。

如需自訂 log4j 配置需求的使用者，請參考文檔進行設定：fanruan.log優化

3.1 查看操作日誌

操作日誌預設儲存在%FR_HOME%\webapps\webroot\logs\cubes不支持修改存储位置。

• 常用的操作日志，系统已主动为您分析，详情请参见：平台日志

• 全部的操作日誌，儲存在cubes資料夾中，可透過資料連結進行查詢分析。詳情請參見：报表日志 LogDB 数据库

3.2 修改存储位置

操作日誌預設儲存在%FR_HOME%\webapps\webroot\logs\cubes資料夾中。11.0版本的、Tomcat伺服器部署的工程支援修改儲存位置。

注：设计器工程不支持修改操作日志的存储位置。

1）Windows 修改%Tomcat%/bin目錄下的 catalina.bat 檔案，增加配置，配置完成後重啓工程。

等於號“=”後面指定路徑，相對路徑會自動在bin目錄下生成logs資料夾，也可使用絕對路徑。

SET JAVA_OPTS="$JAVA_OPTS -DSWIFT_HOME=logs”"

2）Linux/Unix 修改%Tomcat%/bin目錄下的 catalina.sh 檔案，增加配置，配置完成後重啓工程。

等於號“=”後面指定路徑，相對路徑會自動在bin目錄下生成logs資料夾，也可使用絕對路徑。

JAVA_OPTS="$JAVA_OPTS -DSWIFT_HOME=logs"

3.3 備份操作日誌

11.0.4 及之後版本的工程，支援操作日誌的實時備份和還原。

3.3.1 實時備份操作日誌

管理者登入數據決策系統，點選「管理系統>智慧維運>平台日誌」，點選「全局設定」，可開啓「操作日誌實時備份」按鈕，如下圖所示：

操作日誌實時備份的表包括：

• fine_record_execute

• fine_record_operate

• fine_record_email

• fine_record_write

• fine_schedule_record

開啓「操作日誌實時備份」後，在%FR_HOME%\webapps\webroot\logs\swift_backup下生成備份檔案，按照時間戳來分別儲存，如20211105。如下圖所示：

操作日誌每寫入一筆資料，備份檔案中記錄一筆資料。

備份檔案會跟隨 3.4 節操作日誌的清理邏輯來清理。

3.3.2 還原操作日誌

僅當開啓了「操作日誌實時備份」按鈕後，方可進行操作日誌的還原。

點選「操作日誌備份還原」按鈕，跳出日期選擇框。選擇需要還原的操作日誌日期區間，點選「確定」。

耐心等待一段時間後，跳出「備份還原成功」彈窗。操作日誌即可成功還原，如下圖所示：

注1：若还原过程中刷新页面，再次点击「操作日志备份还原」按钮，会跳出「正在备份」弹窗，请耐心等待即可。

注2：若还原时检测到内存不足，会跳出提示用户清理磁盘

注3：若还原时检测到备份文件损坏，会提示备份文件损坏，不进行备份。

3.4 清理操作日誌

超級管理者登入數據決策系統，點選「管理系統>智慧維運>平台日誌」，點選「全局設定」，可對操作日誌檔案進行清理，可以設定「自動清理」和「手動清理」。

1）自動清理：每隔 3 個月自動清理一次，保留近 3 個月的資料。最少會保留3個月，最多實際上會有6個月。

2）手動清理：預設保留近 3 個月的資料，可選擇 0天、1天、1週、1個月、3個月、6個月、12個月。

注1：「操作日誌清理」設定僅影響操作日誌的清理，不影響系統日誌。

注2：近 3 個月是指當前日期往前 3 個月的資料，例如 2019-8-19 日手動清理，預設保留 2019-5-19 ~ 2019-8-19 日的資料。

注3: 清理日誌後發現 cubes 資料夾佔用空間仍然很大，原因在於只是清理資料夾裏面的檔案，不會清理資料夾，該目錄下資料夾特別多，而且佔用比較大的空間。

注4：清理後顯示的「當前日誌大小」不是磁碟佔用空間的概念，而是實際所有檔案的大小。詳情參見：

• Windows：windows系统中文件大小和占用空间不同的原因解析 

• Linux：du和ls查看文件大小的区别

如下图所示：

3）清理预警

日誌檔案過大時通知相關使用者，相關使用者可對日誌進行手動清理，減小日誌檔案大小。

開啓預警功能，設定觸發條件，例如日誌檔案大於 xxxM。

簡訊提醒需要「開啓簡訊功能」，詳細設定請查看  短信 ，同時郵件提醒也需要配置發件人，詳細設定請查看同时邮件邮箱 。

然後勾選「簡訊提醒」、「平台訊息」、「郵件提醒」，再分別設定設定收件人，設定完成後點選「儲存」，如下圖所示：

簡訊提醒效果如下圖所示：

平台訊息效果如下圖所示：

邮件提醒效果如下图所示：

补充日志存储在%FR_HOME%\bin\error.txt文件中，不支持修改存储位置。

补充日志主要记录设计器预期外的报错。