Tomcat 使用 Log4j 输出详细系统日志信息,快速诊断启动故障

Tomcat 启动时的系统日志默认是由 JdkLog14Logger 打印出来的,如

2008-7-7 11:19:34 org.apache.catalina.core.StandardEngine start
信息: Starting Servlet Engine: Apache Tomcat/5.0.28
2008-7-7 11:19:34 org.apache.catalina.core.StandardHost start
信息: XML validation disabled
2008-7-7 11:19:34 org.apache.catalina.core.StandardHost getDeployer
信息: Create Host deployer for direct deployment ( non-jmx )

那我们能不能用 Log4J 来输出这种系统日志呢?我们知道像 Apache 那样的大部分开源框架、组件都是用通用日志组件 (commons-logging) 来输出日志的,因此如果把 commons-logging 和 log4j 搭配使用就能输出十分详尽的日志信息。

尤其是碰到 Tomcat 几乎能令人抓狂的 Error filterStart ,如控制台下得到如下信息:

2007-3-13 17:43:46 org.apache.catalina.core.StandardContext start
严重: Error filterStart
2007-3-13 17:43:46 org.apache.catalina.core.StandardContext start
严重: Context startup failed due to previous errors

而茫然不知所措时,免不了会胡乱猜测,更容易使你的注意力集中在所有的 filter 本身上,其实有些冤枉 filter 了。至少网上针对这个问题有许多不明确的解,有配置文件问题的,有缺类少包的问题等,不一定能和你的实际问题对上号。

其实大可不必受如此之周折,解铃仍需寄铃人吗,由 Tomcat 给你落下的结,当然要 Tomcat 告诉你是怎么回事。很多人在自己的应用中会安放一个日志文件,却可能忽略掉 Tomcat 自身的日志文件,在 logs 目录下的 localhost_log.yyyy-MM-dd.txt 就事,记住只要碰到关于 Tomcat 本身启动的问题,查看其中当前的日志信息的话,问题就会坦荡荡荡显露在你的前面,基本也就能迎刃而解了。

前面讲过,commons-logging+log4j 可以输出极详尽的信息,那现在就来说说如何配置。很多人开发过程中是通过 MyEclipse 来启动 Tomcat 的,所有这里包括两种方法,分别介绍如下:

1. MyEclipse 启动 Tomcat 使用 Log4j 输出日志信息的配置

在 MyEclipse 的 Tomcat 服务器配置中的 Prepend to classpath 或者 Append to classpath 中加入

commons-logging-1.1.jar
log4j-1.2.13.jar
以及 log4j.properties 所在目录,如 D:\Tomcat\Tomcat 5.0.28-Test\bin

如图:

我是把 commons-logging-1.1.jar、log4j-1.2.13.jar 和 log4j.properties 都放在 %TOMCAT_HOME%\bin 目录下的,当然你也可以放在别处。

完了之后,通过 MyEclipse 启动 Tomcat 时就能看到让你眼花花的日志滚屏,请根据实际需要在log4j.properties 中屏蔽你不想关注的内容。所以像这种日志信息最好是记录在文件中,屏幕的缓冲区是有限且耗内存的。真正需要的时候你就可以从这个日志文件里读懂 Tomcat 的启动全过程。

如果你明白 commons-logging.properties 的功用,你也可以把这个文件放在与 log4j.properties 所在的目录下,可在其中指定其他 log 实现类,详见 commons-logging.properties 文件的内容。

2. startup.bat 启动 Tomcat 使用 Log4j 输出日志信息的配置

按前面推荐的做法,把 commons-logging-1.1.jar、log4j-1.2.13.jar 和 log4j.properties 都放在 %TOMCAT_HOME%\bin 目录下,然后修改 catalina.bat 文件,找到

set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\bin\bootstrap.jar

行,在其后附上这两个包和 log4j.properties 所在目录到 classpath 上,修改后就是:

set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\bin\bootstrap.jar;%CATALINA_HOME%\bin\commons-logging-1.1.jar;%CATALINA_HOME%\bin\log4j-1.2.13.jar;%CATALINA_HOME%\bin

保存,通过 startup.bat 启动就会用 log4j 来输出启动日志了,其他平台下的 Tomcat,请参照平台特性修改 catalina.sh 吧。

同样,你也可以应用 commons-logging.properties 指定其他的 log 实现,因为 Log4j 是它的默认实现,所以可省去。

用 Log4j 输出的启动日志形式如下:

15:36:37,859 org.apache.catalina.startup.Embedded.initNaming(Embedded.java:922) - Setting naming prefix=org.apache.naming
15:36:38,046 org.apache.catalina.startup.Catalina.createStartDigester(Catalina.java:350) - Digester for server.xml created 171
15:36:38,218 org.apache.catalina.core.NamingContextListener.<init>(NamingContextListener.java:83) - new NamingContextListener

许多你希望深入了解的内部细节都可以通过这样一份日志追踪到。

附上这两个属性文件的:log4j.properties 和 commons-logging.properties。

log4j.properties

commons-logging.properties

类别: Mid-Ware. 标签: , , . 阅读(708). 订阅评论. TrackBack.

Leave a Reply

1 Comment on "Tomcat 使用 Log4j 输出详细系统日志信息,快速诊断启动故障"

avatar
Werther
Guest

Thanks you!