循序渐进看Java web日志跟踪(1)-Tomcat 日志追踪与配置
日志,是软件运行过程中,对各类操作中重要信息的记录。 日志跟踪,不管对于怎么样的项目来说,都是非常重要的一部分,它关系到项目后期的维护和排错,起着举足轻重的作用。项目开发过程中,对日志的记录规则,也将影响到改项目后期维护的难度。
在开发过程中,我们经常遇到的日志记录方式包括有系统输出(System.out,最基础方式),日志框架输出(log4J 等)和分布式日志框架输出等。作为项目的开发者,和后期的管理者来说,对于日志的管理,除了需要知道如何进行日志输出,还需要关注的是,项目后期对日志文件的管理。
日志追踪第一步(web容器日志)
在此分享下自己在学习过程中的经历,本人虽然说是学计算机的,可是学校的Java课程并没怎么学习,大部分的Java知识都是在课后自学的。在最先开始,本人并没有接触到所谓的日志框架,哪怕是在搭建SSH项目的过程中,知道有这样的框架,知道三大框架都采用了这样的日子框架进行日志记录,可是还是没有主动的是去使用,所以在最先开始的时候,本人还是使用最原始的System.out,来进行日志的追踪。在项目开发的工程中,遇到了问题,就System.out一下,看看输出的是啥,然后再排错,我觉得应该不止是我一个人,采用的是这样的老办法吧。这样的问题来了,出了问题去哪找?
其实,不论我们有没有日志输出,只要我们采用的是成型的web容器,web容器就会对一些必要的信息进行日志的记录。在此以最常用的tomcat为例。
tomcat服务器的日志文件配置保存在$CATALINA_HOME/conf目录下的loggin.properties中(在此不做详解),而对应的日志文件,则保留在$CATALINA_HOME/logs目录下。Tomcat容器默认按照日期进行日志的保存,每天都会产生对应于当天的日志文件,其中包括:容器输出、管理日志、访问日志等。我们常见的tomcat启动输出,就对应的在容器日志文件中。对于一些tomcat的错误信息,可以通过这些日志文件进行排查
对于日志输出的规则和保留的目录,不同的web容器采用的方式不同,因此需要根据对应的web容器进行日志查找,在此不再举例了
日志追踪第二步(System.out在哪里)
在此说一下,编程过程中,除了System.out以外,当异常抛出或者是说异常处理的e.printstrack,也都采用的是out输出。从编程角度上看,提出尽量规范化编程,减少System.out和e.printstrack的输出,可是,当这一部分不可避免的时候,就得好好的利用它
作为常用的web容器,tomcat对系统输出有自己的一套管理方法,根据不同管理系统,有不同的配置。
在Linux下,tomcat会为对应的实例创建一个.out文件,放在$CATALINA_HOME/logs目录下,方便后期的排错使用。然而,该文件默认不能自动分割,在没有配置的情况下,该文件会不断的增大,日久天长,或许等到需要排错的时候,该文件的大小可以以G为单位了。所以,在配置完tomcat实例之后,建议修改一下启动文件,让.out文件随着日期的变化自增。
具体的配置如下:
vim catalina.sh
找到catalina.out所在处,将其改为catalina.$(date +%Y-%m-%d) .out(注意date之后的空格)
改完之后,重启tomcat,会发现,tomcat会根据日期的不同,动态的创建.out文件
在Windows下,启动tomcat通常需要启动一个控制台,同时该控制台需要一直开着,tomcat的SYstem.out 也默认为控制台输出。也就是说,开发者所写的System.out,还有异常输出,都会打印在控制台上面。所以如果出了问题,找控制台就行了。。
但是,这一种方式显然非常麻烦,Windows控制台显示查看是有限制的,同时也没有持久化的文件保存下来。所以,需要通过配置tomcat的配置文件,来实现与Linux同样的效果。
1、打开startup.bat文件,找到call "%EXECUTABLE%" start %CMD_LINE_ARGS%, 改为call "%EXECUTABLE%" run %CMD_LINE_ARGS% 。
2、打开catalina.bat文件,在4处 %ACTION% 后面加上 >> %CATALINA_HOME%\logs\catalina.out 。重启tomcat,tomcat的logs文件夹下就会出现catalina.out文件了。
按照上面的方法,同样存在着.out无限变大的问题。如果想要其按照日期进行配置可以通过将catalina.out改为catalina.%date:~0,4%-%date:~5,2%-%date:~8,2%.out,重启即可
至此,关于tomcat的日志追踪,整理完毕。其中部分资源来自网络。