用Java實(shí)現(xiàn)的日志切割清理工具
作者：~怪^_*獸~
對(duì)于服務(wù)器的日常維護(hù)來(lái)說(shuō)，日志清理是非常重要的事情，如果殘留日志過(guò)多則嚴(yán)重浪費(fèi)磁盤(pán)空間同時(shí)影響服務(wù)的性能。如果用手工方式進(jìn)行清理，會(huì)花費(fèi)太多時(shí)間，并且很多時(shí)候難以滿(mǎn)足實(shí)際要求。
對(duì)于服務(wù)器的日常維護(hù)來(lái)說(shuō)，日志清理是非常重要的事情，如果殘留日志過(guò)多則嚴(yán)重浪費(fèi)磁盤(pán)空間同時(shí)影響服務(wù)的性能。如果用手工方式進(jìn)行清理，會(huì)花費(fèi)太多時(shí)間，并且很多時(shí)候難以滿(mǎn)足實(shí)際要求。例如：如何在每個(gè)星期六凌晨3點(diǎn)把超過(guò)2G大的日志文件進(jìn)行切割，保留最新的100M日志記錄？
網(wǎng)上沒(méi)有發(fā)覺(jué)能滿(mǎn)足本座要求的日志切割工具，因此花了一些閑暇時(shí)間自己寫(xiě)了一個(gè)。由于要在多個(gè)平臺(tái)上使用，為了方便采用 Java 實(shí)現(xiàn)。本工具命名為 LogCutter，主要有以下特點(diǎn)：
- 支持 Linux、Mac 和 Windows 等所有常見(jiàn)操作系統(tǒng)平臺(tái)
- 支持命令行交互式運(yùn)行
- 支持后臺(tái)非交互式運(yùn)行（Linux/MAC 下使用 daemon 進(jìn)程實(shí)現(xiàn)，Windows 用系統(tǒng) Service 實(shí)現(xiàn)）
- 支持兩種日志清理方式（刪除日志文件或切割日志文件）
- 支持對(duì) GB18030、UTF-8、UTF-16LE、UTF-16BE 等常用日志文件類(lèi)型進(jìn)行切割（不會(huì)發(fā)生切掉半個(gè)字符的情況）
- 高度可配置（程序執(zhí)行周期、要?jiǎng)h除的日志文件過(guò)期時(shí)間、要切割的日志文件閥值和保留大小等均可配置
使用方法：
- *******************************************************
- **** LogCutter - Bruce Liang, all rights reserved. ****
- *******************************************************
- 一、啟動(dòng)方式
- --------------------------------------------------
- ) Windows
- A) 前臺(tái)運(yùn)行: > ./run.bat
- B) 后臺(tái)運(yùn)行: > ./LogCutter.exe {
- -install-demand (安裝手動(dòng)啟動(dòng)服務(wù))
- -install-auto (安裝自動(dòng)啟動(dòng)服務(wù))
- -start (啟動(dòng)服務(wù))
- -stop (停止服務(wù))
- -status (查看服務(wù)狀態(tài))
- }
- *** 注 ***
- @ LogCutter.exe 以 Windows 系統(tǒng)服務(wù)的方式運(yùn)行，安裝好后也可以通過(guò) Windows 服務(wù)管理器進(jìn)行管理
- @ LogCutter.exe 依賴(lài) JRE 1.6, 因此必須在注冊(cè)表或環(huán)境變量中設(shè)置 %JAVA_HOME%
- ) Linux / Unix
- A) 前臺(tái)運(yùn)行: $ ./run.sh
- B) 后臺(tái)運(yùn)行: $ ./run.sh -d
- *** 注 ***
- @ 可以設(shè)置為開(kāi)機(jī)時(shí)自動(dòng)后臺(tái)運(yùn)行，方法如下:
- $ vi /etc/rc.d/rc.local
- ( 加入: ${YOUR_LOGCUTTER_PATH}/run.sh -d )
- --------------------------------------------------
- 二、配置文件
- --------------------------------------------------
- ) 程序配置文件: ./conf/config.xml
- ) 日志配置文件: ./conf/log4j.properties (默認(rèn))
- --------------------------------------------------
- 三、環(huán)境要求
- --------------------------------------------------
- ) Java 版 本: JRE 1.6 以上
- ) 依賴(lài)程序包: dom4j、log4j、juniversalchardet
- --------------------------------------------------
run.sh (Mac 平臺(tái))
- #!/bin/bash
- JAVA_HOME="/Library/Java/Home"
- CLASSPATH=$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
- JAVA_BIN=$JAVA_HOME/bin
- JAVA=$JAVA_BIN/java
- APP_PATH="/Users/Kingfisher/MyWork/Java/LogCutter"
- APP_CLASSPATH=$APP_PATH/classes
- APP_LIBPATH=$APP_PATH/lib
- APP_LIBS=$APP_LIBPATH/dom4j-1.6.1.jar:$APP_LIBPATH/log4j-1.2.16.jar:$APP_LIBPATH/juniversalchardet-1.0.3.jar
- APP_CONFPATH=$APP_PATH/conf
- APP_CONFFILE=$APP_CONFPATH/config.xml
- APP_MAIN_CLASS=com.bruce.main.LogCutter
- DAEMON='-d'
- CMD="$JAVA -cp $CLASSPATH:$APP_CLASSPATH:$APP_LIBS $APP_MAIN_CLASS -f $APP_CONFFILE"
- if [ $# -eq 0 ]
- then
- $CMD
- elif [ "$#" -eq 1 -a "$1" = "$DAEMON" ]
- then
- $CMD &
- else
- echo "Usage: $0 [ $DAEMON ]"
- exit 1
- fi
交互式運(yùn)行操作演示：
- [Kingfisher@Bruce-mbp LogCutter] $ pwd
- /Users/Kingfisher/MyWork/Java/LogCutter
- [Kingfisher@Bruce-mbp LogCutter] $ ./run.sh
- command line usage
- ------------------------------------------------------------
- HELP : Show help
- JOBS : Show jobs status
- CFG : Show configuration summary
- RUN : Schedule jobs manually
- !Q : Shutdown application
- ? : About me
- ------------------------------------------------------------
- > help
- command line usage
- ------------------------------------------------------------
- HELP : Show help
- JOBS : Show jobs status
- CFG : Show configuration summary
- RUN : Schedule jobs manually
- !Q : Shutdown application
- ? : About me
- ------------------------------------------------------------
- > jobs
- jobs summary (total: 2, active: 0)
- ------------------------------------------------------------
- . DelFileRunner@334936591 [ Idle ]
- . CutFileRunner@724646150 [ Idle ]
- ------------------------------------------------------------
- > cfg
- configuration summary
- ------------------------------------------------------------
- [global]
- start-check-delay : 1 hours
- check-interval : 24 hours
- log4j-config-file : /Users/Kingfisher/MyWork/Java/LogCutter/classes/../conf/log4j.properties
- lock-file : /Users/Kingfisher/MyWork/Java/LogCutter/classes/../LogCutter.lock
- [delete-files] (expire: 30 days)
- . /opt/LogCutter/logs/LogCutter.log*
- . /opt/tomcat6-logs/*.log
- . /opt/tomcat7-logs/*.log
- [cut-files] (threshold: 30960 KBs, reserve: 1024 KBs)
- . /opt/apache-logs/*_log
- . /opt/nginx-logs/*.log
- . /opt/tomcat6-logs/catalina.out
- . /opt/tomcat7-logs/catalina.out
- . /var/lib/mysql/*.err
- ------------------------------------------------------------
- > run
- manual jobs are scheduled !
- > ?
- LogCutter 1.0.2 - Bruce Liang, all rights reserved.
- ------------------------------------------------------------
- Description : schedule to DELETE and CUT text log files automatically or manually.
- Support : GB18030, UTF-8, UTF-16LE and UTF-16BE text file types.
- Usage : java com.bruce.main.LogCutter [ -f <config-file> ]
- (default config file is '/Users/Kingfisher/MyWork/Java/LogCutter/classes/../conf/config.xml')
- ------------------------------------------------------------
- > !q
- be about to shutdown, please wait ...
- shutdown perfectly !
后臺(tái)運(yùn)行演示（Mac 平臺(tái)）：
- [Kingfisher@Bruce-mbp LogCutter] $ ./run.sh -d
- [Kingfisher@Bruce-mbp LogCutter] $
- LogCutter is running in background, use 'kill 4544' to stop me.
- [Kingfisher@Bruce-mbp LogCutter] $ kill 4544
- [Kingfisher@Bruce-mbp LogCutter] $
- !! LogCutter received terminate signal !!
- be about to shutdown, please wait ...
- shutdown perfectly !
- [Kingfisher@Bruce-mbp LogCutter] $
程序運(yùn)行日志
- :52:20,705 INFO [main]: ->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->->
- :52:20,706 INFO [main]: starting: class com.bruce.main.LogCutter ...
- :52:20,707 INFO [main]: configuration summary
- ------------------------------------------------------------
- [global]
- start-check-delay : 1 hours
- check-interval : 24 hours
- log4j-config-file : /Users/Kingfisher/MyWork/Java/LogCutter/classes/../conf/log4j.properties
- lock-file : /Users/Kingfisher/MyWork/Java/LogCutter/classes/../LogCutter.lock
- [delete-files] (expire: 30 days)
- . /opt/LogCutter/logs/LogCutter.log*
- . /opt/tomcat6-logs/*.log
- . /opt/tomcat7-logs/*.log
- [cut-files] (threshold: 30960 KBs, reserve: 1024 KBs)
- . /opt/apache-logs/*_log
- . /opt/nginx-logs/*.log
- . /opt/tomcat6-logs/catalina.out
- . /opt/tomcat7-logs/catalina.out
- . /var/lib/mysql/*.err
- ------------------------------------------------------------
- :52:39,062 INFO [pool-1-thread-2]: - - - - - - - -> start CutFileRunner@724646150 <- - - - - - - -
- :52:39,062 INFO [pool-1-thread-1]: - - - - - - - -> start DelFileRunner@334936591 <- - - - - - - -
- :52:39,063 INFO [pool-1-thread-2]: - - - - - - - -> end CutFileRunner@724646150 <- - - - - - - -
- :52:39,063 INFO [pool-1-thread-1]: - - - - - - - -> end DelFileRunner@334936591 <- - - - - - - -
- :52:54,222 INFO [main]: stoping: class com.bruce.main.LogCutter ...
- :52:54,222 INFO [main]: <-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-
程序配置文件（./conf/config.xml）
- <?xml version="1.0" encoding="UTF-8"?>
- <CONFIG>
- <global>
- <!-- 開(kāi)始日志檢查延時(shí) (小時(shí)), 默認(rèn): 0 (立刻開(kāi)始) -->
- <start-check-delay>1</start-check-delay>
- <!-- 日志檢查間隔 (小時(shí)), 默認(rèn): 72 -->
- <check-interval>24</check-interval>
- <!-- Log4J 配置文件, 默認(rèn): ${CLASS_ROOT}/../conf/log4j.properties -->
- <log4j-config-file></log4j-config-file>
- <!-- 程序鎖, 默認(rèn): ${CLASS_ROOT}/../${APP_NAME}.lock -->
- <lock-file></lock-file>
- </global>
- <!-- 要?jiǎng)h除的日志文件列表 -->
- <!-- delete-files.expire: 日志文件過(guò)期時(shí)間(天), 默認(rèn): 90 -->
- <delete-files expire="30">
- <!-- files: 文件名稱(chēng)(不包含目錄), 必須填寫(xiě), 可包含通配符 -->
- <!-- files.path: 文件所在目錄, 必須填寫(xiě), 不能包含通配符 -->
- <file path="/opt/LogCutter/logs">LogCutter.log*</file>
- <file path="/opt/tomcat6-logs">*.log</file>
- <file path="/opt/tomcat7-logs">*.log</file>
- <!--
- <file path="/var/lib/mysql">mysql-bin.*</file>
- <file path="/var/lib/mysql">efly-test-relay-bin.*</file>
- -->
- </delete-files>
- <!-- 要截?cái)嗟娜罩疚募斜?nbsp;-->
- <!-- cut-files.threshold: 日志文件截?cái)嚅y值(KB), 默認(rèn): 10240 -->
- <!-- cut-files.reserve: 日志文件保留內(nèi)容(KB), 默認(rèn): 1024 -->
- <!--
- <!注!> 'cut-files.reserve' 是保留內(nèi)容的近似值得, 實(shí)際內(nèi)容按行取整保留
- 如下列日志文件內(nèi)容:
- ...... ...... ......
- line1: xxxxxxxxxxxxxxxxxxxxx
- line2: xxxxxxxxxxPyyyyyyyyyy
- line3: zzzzzzzzzzzzzzzzzzzzz
- line4: zzzzzzzzzzzzzzzzzzzzz
- ...... ...... ...... (EOF)
- 'P'為定位得到的保留起點(diǎn), 程序?qū)嶋H會(huì)在'P'點(diǎn)開(kāi)始查找下一個(gè)換行符,
- 從該換行符的后一個(gè)字符開(kāi)始保留, 也就是從第三行開(kāi)始保留到文件末尾
- -->
- <cut-files threshold="30960" reserve="1024">
- <file path="/opt/apache-logs">*_log</file>
- <file path="/opt/nginx-logs">*.log</file>
- <file path="/opt/tomcat6-logs">catalina.out</file>
- <file path="/opt/tomcat7-logs">catalina.out</file>
- <file path="/var/lib/mysql">*.err</file>
- </cut-files>
- </CONFIG>
下載試用：http://files.cnblogs.com/ldcsaa/LogCutter.zip
原文鏈接：http://www.cnblogs.com/ldcsaa/archive/2012/02/12/2347689.html
【編輯推薦】
- Java網(wǎng)絡(luò)組件 HttpComponents 4.2-beta1發(fā)布
- 甲骨文發(fā)布JSR 356 針對(duì)WebSocket的Java API
- Disruptor 2.8發(fā)布 Java 并發(fā)編程框架
- jOOQ 2.0.4發(fā)布 Java的ORM框架
- Wordpress Java 0.5 發(fā)布
責(zé)任編輯：林師授
來(lái)源：
~怪^_*獸~的博客
