服務(wù)器日志切割清理工具(LogCutter)

對于服務(wù)器的日常維護(hù)來說，日志清理是非常重要的事情，如果殘留日志過多則嚴(yán)重浪費(fèi)磁盤空間同時影響服務(wù)的性能。如果用手工方式進(jìn)行清理，會花費(fèi)太多時間，并且很多時候難以滿足實際要求。例如：如何在每個星期六凌晨3點(diǎn)把超過2G大的日志文件進(jìn)行切割，保留最新的100M日志記錄？

由于要在多個平臺上使用，為了方便采用 Java 實現(xiàn)。本工具命名為 LogCutter.

更新日志：

版本: 2.0.1
1、增加文件歸檔執(zhí)行器 ArcFileRunner
1) ArcFileRunner 把符合條件的文件或文件夾壓縮歸檔到指定目錄，并刪除原文件或文件夾
2) 屬性 expire 指定歸檔到期時間，屬性 archive-path 指定歸檔目錄
3) 歸檔文件格式：{原文件/文件夾名稱}_{系統(tǒng)時間}.zip
（例如：下面的配置把最后修改時間超過 90 天的文件或文件夾歸檔到 ‘E:\backup’ 目錄）

<archive-files archive-path="E:\backup" expire=90>
<file path="X:\MyApp\logs">*</file>
<file path="X:\nginx-1.4.1\logs">*.log</file>
</archive-files>

2、支持多組文件清理策略
1) config.xml 可以配置多項 <delete-files>、<cut-files> 或 <archive-files>
2) 不同的配置項可以使用不同的清理策略參數(shù)

（例如：下面配置的兩組歸檔清理策略中，分別指定不同的歸檔到期時間和歸檔目錄）

<archive-files archive-path="E:\backup" expire=90>
<file path="X:\MyApp\logs">*</file>
<file path="X:\nginx-1.4.1\logs">*.log</file>
</archive-files>
<archive-files archive-path="E:\backup2" expire=300>
<file path="X:\MyApp2\logs">*</file>
<file path="X:\Tomcat-6\logs">*.log</file>
</archive-files>

3、文件刪除執(zhí)行器 DelFileRunner 支持遞歸刪除文件夾
1) DelFileRunner 會遞歸刪除符合條件的文件夾及其中的所有文件
2) 注意：在判斷是否刪除文件夾時，檢測的是文件夾的最后修改時間，而不是其中文件的最后修改時間

（例如：下面的配置會刪除 logs 目錄下所有最后修改時間超過 90 天的文件或文件夾）

<delete-files expire=90>
<file path="X:\MyApp\logs">*</file>
</delete-files>

4、執(zhí)行器首次啟動延時配置 ‘<start-check-delay>’ 支持指定絕對時間
1) 當(dāng)指定為一個整數(shù)值時，執(zhí)行器首次啟動延時時間為該值設(shè)定的小時數(shù)
2) 當(dāng)指定為一個 ‘hh:mm’ 格式的值時，執(zhí)行器首次啟動時間為該時分值

（例如）

<!-- 12 小時后首次啟動執(zhí)行器 -->
<start-check-delay>12</start-check-delay>
<!-- 12 點(diǎn) 34 分首次啟動執(zhí)行器，如果當(dāng)前時間超過 12 點(diǎn) 34 分則在明天的 12 點(diǎn) 34 分首次啟動執(zhí)行器 -->
<start-check-delay>12:34</start-check-delay>

5、增加單次運(yùn)行模式（running-only-once mode）
1) 在單次運(yùn)行模式下，LogCutter 在啟動時立刻運(yùn)行所有執(zhí)行器，當(dāng)所有執(zhí)行器運(yùn)行完畢后退出程序
2) 單次運(yùn)行模式可避免 LogCutter 作為常駐進(jìn)程一直運(yùn)行，配合 CronTab 等任務(wù)調(diào)度器一起使用則能達(dá)到定時清理的目的
3) 在單次運(yùn)行模式下 運(yùn)行 LogCutter 會忽略配置文件的 ‘start-check-delay’ 和 ‘check-interval’ 配置項
4) 通過命令行參數(shù) ‘-1’ 指示使用單次運(yùn)行模式啟動 LogCutter

（例如）

Windows : > run.bat -1
Unix/Linux : > run.sh -1 [ -d ]

6、優(yōu)化啟動腳本 run.sh / run.bat
1) 只需配置好系統(tǒng)環(huán)境變量 ‘JAVA_HOME’（或 ‘JRE_HOME’） 和 ‘CLASSPATH’ 即可通過啟動腳本運(yùn)行 LogCutter
2) 啟動腳本接受命令行參數(shù)并傳遞到 LogCutter 程序中。其中 run.sh 通過額外的參數(shù) ‘-d’ 指示后臺運(yùn)行 LogCutter

主要特點(diǎn)：

支持 Linux、Mac 和 Windows 等所有常見操作系統(tǒng)平臺

支持命令行交互式運(yùn)行

支持后臺非交互式運(yùn)行（Linux/MAC 下使用 daemon 進(jìn)程實現(xiàn)，Windows 用系統(tǒng) Service 實現(xiàn)）

支持兩種日志清理方式（刪除日志文件或切割日志文件）

支持對 GB18030、UTF-8、UTF-16LE、UTF-16BE 等常用日志文件類型進(jìn)行切割（不會發(fā)生切掉半個字符的情況）

高度可配置（程序執(zhí)行周期、要刪除的日志文件過期時間、要切割的日志文件閥值和保留大小等均可配置

使用方法：

*******************************************************

**** LogCutter - Bruce Liang, all rights reserved. ****
*******************************************************

一、啟動方式
--------------------------------------------------
1) Windows
    A) 前臺運(yùn)行: > ./run.bat
    B) 后臺運(yùn)行: > ./LogCutter.exe {    
                                       -install-demand  (安裝手動啟動服務(wù))
                                       -install-auto    (安裝自動啟動服務(wù))
                                       -start           (啟動服務(wù))
                                       -stop            (停止服務(wù))
                                       -status          (查看服務(wù)狀態(tài))
                                   }

    *** 注 *** 
        @ LogCutter.exe 以 Windows 系統(tǒng)服務(wù)的方式運(yùn)行，安裝好后也可以通過 Windows 服務(wù)管理器進(jìn)行管理
        @ LogCutter.exe 依賴 JRE 1.6, 因此必須在注冊表或環(huán)境變量中設(shè)置 %JAVA_HOME%

2) Linux / Unix
    A) 前臺運(yùn)行: $ ./run.sh
    B) 后臺運(yùn)行: $ ./run.sh -d

    *** 注 ***
        @ 可以設(shè)置為開機(jī)時自動后臺運(yùn)行，方法如下:

        $ vi /etc/rc.d/rc.local
                    ( 加入: ${YOUR_LOGCUTTER_PATH}/run.sh -d )
--------------------------------------------------

二、配置文件
--------------------------------------------------
1) 程序配置文件: ./conf/config.xml
2) 日志配置文件: ./conf/log4j.properties (默認(rèn))
--------------------------------------------------

環(huán)境要求：

1) Java 版 本: JRE 1.6 以上
2) 依賴程序包: dom4j、log4j、juniversalchardet
--------------------------------------------------