日志切割清理工具 Log-Cutter

主页：http://code.google.com/p/ldcsaa/

Log-Cutter 是JessMA开源组织开发的一个简单实用的日志切割清理工具。对于服务器的日常维护来说，日志清理是非常重要的事情，如果残留日志过多则严重浪费磁盘空间同时影响服务的性能。如果用手工方式进行清理，会花费太多时间，并且很多时候难以满足实际要求。例如：如何在每个星期六凌晨3点把超过 2G 大的日志文件进行切割，保留最新的 100M 日志记录？ 网上没有发现能满足本座要求的日志切割工具，因此花了一些闲暇时间自己写了一个。由于要在多个平台上使用，为了方便采用 Java 实现。本工具命名为 Log-Cutter，主要有以下特点 ：

1. 支持 Linux、Mac 和 Windows 等所有常见操作系统平台
2. 支持命令行交互式运行
3. 支持后台非交互式运行（Linux/MAC 下使用 daemon 进程实现，Windows 用系统 Service 实现）
4. 支持三种日志清理方式：删除日志文件、切割日志文件、归档日志文件
5. 支持对 GB18030、UTF-8、UTF-16LE、UTF-16BE 等常用日志文件类型进行切割
6. 高度可配置（程序执行周期、要删除的日志文件过期时间、要切割的日志文件阀值和保留大小等均可配置）

• 使用方法：

01	**************************************************************

02	**** LogCutter - JessMA Open Source, all rights reserved. ****

03	**************************************************************

04

05

一、环境要求

06	--------------------------------------------------

07	1) Java 版 本: JDK / JRE 1.6 以上

08	2) 依赖程序包: dom4j、log4j、ant、juniversalchardet

09	--------------------------------------------------

10

11

二、配置文件

12	--------------------------------------------------

13	1) 程序配置文件: conf/config.xml (默认)

14	（示例参考：conf/config-template.xml）

15	2) 日志配置文件: conf/log4j.properties (默认)

16	（示例请参考：conf/log4j.properties）

17	--------------------------------------------------

18

19

三、安装部署

20	（注 ：LogCutter 需要配置 ‘JAVA_HOME’ / ‘JRE_HOME’ 和 ‘CLASSPATH’ 系统环境变量）

21	--------------------------------------------------

22	1) 配置系统环境变量 ‘JAVA_HOME’（或 ‘JRE_HOME’） 和 ‘CLASSPATH’

23	2) 在 LogCutter配置文件（默认：conf/config.xml）中配置清理规则

24	3) 启动 LogCutter

25	--------------------------------------------------

26

27

四、启动方式

28	--------------------------------------------------

29	1) Windows

30	A) 前台运行: > run.bat [ -f config-file ]

31

32	B) 后台运行: > LogCutter.exe  {

33	-install-demand  (安装手动启动服务)

34	-install-auto    (安装自动启动服务)

35	-uninstall       (删除服务)

36	-start           (启动服务)

37	-stop            (停止服务)

38	-status          (查看服务状态)

39

}

40

41

*** 注 ***

42	@ LogCutter.exe 以 Windows 系统服务的方式运行，安装好后也可以通过 Windows 服务管理器进行管理

43	@ LogCutter.exe 是 32 位程序，LogCutter_x64.exe 是 64 位程序，根据当前系统平台使用其中之一

44

45	C) 单次运行: > run.bat -1 [ -f config-file ]

46

47	2) Linux / Unix

48	A) 前台运行: $ run.sh [ -f config-file ]

49	B) 后台运行: $ run.sh [ -f config-file ] -d

50	C) 单次运行: $ run.sh -1 [ -f config-file ] [ -d ]

51

52

*** 注 ***

53	@ 可以把 run.sh 启动命令加入 /etc/rc.d/rc.local 中，从而设置为开机时自动运行

54	--------------------------------------------------

• 配置文件

01	<?xml version="1.0" encoding="UTF-8"?>

02	<CONFIG  xmlns="http://www.jessma.org"

03	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

04	xsi:schemaLocation="http://www.jessma.org http://www.jessma.org/schema/log-cutter-cfg-2.0.xsd">

05

<global>

06	<!-- 开始日志检查延时 (小时), 默认: 0 (立刻开始)

07

08	1) 当指定为一个整数值时，执行器首次启动延时时间为该值设定的小时数

09	（例如：12 小时后首次启动执行器）

10	<start-check-delay>12</start-check-delay>

11

12	2) 当指定为一个 ‘hh:mm’ 格式的值时，执行器首次启动时间为该时分值

13	（例如：12 点 34 分首次启动执行器，如果当前时间超过 12 点 34 分则在明天的 12 点 34 分首次启动执行器）

14	<start-check-delay>12:34</start-check-delay>

15

-->

16	<!-- 02 点 30 分首次启动执行器 -->

17	<start-check-delay>02:30</start-check-delay>

18	<!-- 日志检查间隔 (小时), 默认: 72 -->

19	<check-interval></check-interval>

20	<!-- Log4J 配置文件, 默认: ${CLASS_ROOT}/../conf/log4j.properties -->

21	<log4j-config-file></log4j-config-file>

22	<!-- 进程锁文件, 默认: ${CLASS_ROOT}/../${APP_NAME}.lock -->

23	<lock-file></lock-file>

24

</global>

25

26	<!-- 要删除的日志文件列表（可配置多个，由 DelFileRunner 执行）

27	1) DelFileRunner 会递归删除符合条件的文件夹及其中的所有文件

28	2) 注意：在判断是否删除文件夹时，检测的是文件夹的最后修改时间，而不是其中文件的最后修改时间

29	3) DelFileRunner 适用于清理 “定期产生新日志文件” 的应用程序日志

30

-->

31	<!-- delete-files.expire: 日志文件过期时间(天), 默认: 90 -->

32	<delete-files expire="30">

33	<!-- file.path: 文件所在目录, 必须填写, 不能包含通配符 -->

34	<!-- file: 文件或文件夹名称, 必须填写, 可包含通配符 -->

35	<file path="D:\LogCutter\logs">LogCutter.log*</file>

36	<file path="D:\hMailServer\Logs">*.log</file>

37	<file path="D:\Tomcat 6.0\logs">*.log</file>

38	</delete-files>

39	<delete-files expire="365">

40	<file path="E:\backup">*</file>

41	</delete-files>

42

43	<!-- 要截断的日志文件列表（可配置多个，由 CutFileRunner 执行）

44	1) CutFileRunner 只会扫描符合条件的文件，不会扫描文件夹

45	2) CutFileRunner 会截断文件的前部内容，保留后部内容

46	3) CutFileRunner 适用于清理 “日志文件不断追加增长” 的应用程序日志

47

-->

48	<!-- cut-files.threshold:    日志文件截断阀值(KB), 默认: 10240 -->

49	<!-- cut-files.reserve:      日志文件保留内容(KB), 默认: 1024 -->

50

<!--

51	<!注!> 'cut-files.reserve' 是保留内容的近似值, 实际内容按行取整保留

52	如下列日志文件内容:

53	...... ...... ......

54	line1: xxxxxxxxxxxxxxxxxxxxx

55	line2: xxxxxxxxxxPyyyyyyyyyy

56	line3: zzzzzzzzzzzzzzzzzzzzz

57	line4: zzzzzzzzzzzzzzzzzzzzz

58	...... ...... ...... (EOF)

59	'P'为定位得到的保留起点, 程序实际会在'P'点开始查找下一个换行符,

60	从该换行符的后一个字符开始保留, 也就是从第三行开始保留到文件末尾

61

-->

62	<cut-files threshold="10240" reserve="512">

63	<file path="D:\Apache-2.2\logs">*.log</file>

64	<file path="D:\MySQL Server 5.1\data">*.err</file>

65	</cut-files>

66

67	<!-- 要归档的日志文件列表（可配置多个，由 ArcFileRunner 执行）

68	1) ArchiveFileRunner 把符合条件的文件或文件夹压缩归档到指定目录，并删除原文件或文件夹

69	2) 归档文件格式：{原文件/文件夹名称}_{系统时间}.zip

70	3) 注意：在判断是否归档文件夹时，检测的是文件夹的最后修改时间，而不是其中文件的最后修改时间

71	4) ArchiveFileRunner 适用于清理 “定期产生新日志文件或日志目录” 的应用程序日志

72

-->

73	<!-- archive-files.expire:    日志文件过期时间(天), 默认: 90 -->

74	<!-- archive-files.archive-path: 日志文件归档目录 -->

75	<archive-files expire="120" archive-path="E:\backup">

76	<file path="D:\MySQL Server 5.1\data">mysql-bin.*</file>

77	</archive-files>

78

</CONFIG>