tomcat日志排查

分手后的思念是犯贱 2021-12-24 06:07 455阅读 0赞

# tomcat里的几类日志: Catalina localhost manager host-manager access #

# 前言：有时候我们会碰到代码本地测试没问题，然鹅发到生产却出现了问题。这时候想解决问题，在本地测试没多大效果的，最好的办法是去生产上把日志搂出来，根据异常日志来排查问题，但是生产上那么多日志该如何下手呢? #

## 项目中常用的三种日志catalina.out catalina.log localhost.log ##

![Alt text][]  
一般我们应该从catalina.out，catalina.log和localhost.log三类日志着手。catalina.log和localhost.log是滚动生成的，后面接的有日期，格式可以是可以配的。配置在tomcat\\conf下的logging.properties里面。

### catalina.out ###

catalina.out 是tomcat的标准输出(stdout)和标准出错(stderr)，这是在tomcat的启动脚本里指定的，如果没有修改的话stdout和stderr会重定向到这里。所以我们在应用程序中使用System.out/err打印的东西都会到这里来。另外，我们所有输出到控制台的日志也会记录进来。比如我们常用的log4j，当我们配置log4j.appender.stdout=org.apache.log4j.ConsoleAppender时，所有输出到控制台的log4j日志也会记录到Catalina.out中。所以一般情况下ConsoleAppender的日志级别需要配高一点，不然Catalina.out会显得特别臃肿，查找信息时也不太方便。比如测试的时候我一般用DEBUG级别，发生产用ERROR级别。当然你也可以关掉它，只需设置：

java.util.logging.ConsoleHandler.level = OFF

或者修改Tomcat\\bin目录下的catalina.sh

if [ -z "$CATALINA_OUT" ] ; then
          CATALINA_OUT="$CATALINA_BASE"/logs/catalina.out
        修改为
        if [ -z "$CATALINA_OUT" ] ; then
          CATALINA_OUT=/dev/null
        这样就不会生成catalina.out文件了

### catalina.log和localhost.log ###

在Tomcat的conf目录下可以找到logging.properties文件,里面配置了catalina.log和localhost.log相关的信息.默认情况下，启动脚本里指定了java.util.logging.config.file和java.util.logging.manager两个变量。一个典型的logging.properties可能如下所示:

handlers = 1catalina.org.apache.juli.FileHandler, 2localhost.org.apache.juli.FileHandler, java.util.logging.ConsoleHandler
    
    .handlers = 1catalina.org.apache.juli.FileHandler, java.util.logging.ConsoleHandler
    1catalina.org.apache.juli.FileHandler.level = FINE
    1catalina.org.apache.juli.FileHandler.directory = ${catalina.logs}
    1catalina.org.apache.juli.FileHandler.prefix = catalina.log.
    1catalina.org.apache.juli.FileHandler.suffix = 
    1catalina.org.apache.juli.FileHandler.formatter = com.taobao.tomcat.juli.SimpleFormatter
    
    2localhost.org.apache.juli.FileHandler.level = FINE
    2localhost.org.apache.juli.FileHandler.directory = ${catalina.logs}
    2localhost.org.apache.juli.FileHandler.prefix = localhost.log.
    2localhost.org.apache.juli.FileHandler.suffix =
    2localhost.org.apache.juli.FileHandler.formatter = com.taobao.tomcat.juli.SimpleFormatter
    
    java.util.logging.ConsoleHandler.level = FINE
    java.util.logging.ConsoleHandler.formatter = com.taobao.tomcat.juli.SimpleFormatter
    
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].level = INFO
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].handlers = 2localhost.org.apache.juli.FileHandler

这个文件中directory表示日志生成地址，prefix是日志名前缀，suffix是日志名后缀，formatter是日志的格式化输出，level表示日志级别。而这里的catalina按照配置对应的是catalina.log.\{yyyy-MM-dd\}，这里的console最终会输出到catalina.out。这就是我们看到catalina.log.\{yyyy-MM-dd\}和catalina.out的日志很多都是一样的原因。

所有logname或parent logname为org.apache.catalina.core.ContainerBase.\[Catalina\].\[localhost\]的都会输出到localhost.log.\{yyyy-MM-dd\}文件。而这个logname又代表着什么呢？在tomcat中有一个server.xml的配置文件，其中有这么一个片段:

我们可以这么简单的理解: 一个Tomcat进程对应着一个Engine，一个Engine下可以有多个Host(Virtual Host)，一个Host里可以有多个Context，比如我们常常将应用部署在ROOT下还是webapps里其他目录，这个就是Context。

这其中Engine对应着tomcat里的StandardEngine类，Host对应着StandardHost类，而Context对应着StandardContext。这几个类都是从ContainerBase派生。这些类里打的一些跟应用代码相关的日志都是使用ContainerBase里的getLogger，而这个这个logger的logger name就是: org.apache.catalina.core.ContainerBase.\[current container name\].\[current container name\]...

而我们一个webapp里listener, filter, servlet的初始化就是在StandardContext里进行的，比如ROOT里有一个listener初始化出异常了，打印日志则logger name是org.apache.catalina.core.ContainerBase.\[Catalina\].\[localhost\].\[/\]。这其中Catalina和localhost是上面xml片段里的Engine和Host的name，而\[/\]是ROOT对应的StandardContext的name。所以listener, filter, servlet初始化时的日志是需要看localhost.\{yyyy-MM-dd\}.log这个日志的。比如现在我们使用Spring，Spring的初始化我们往往是使用Spring提供的一个listener进行的，而如果Spring初始化时因为某个bean初始化失败，导致整个应用没有启动，这个时候的异常日志是输出到localhost中的，而不是cataina.out中。所以有的时候我们应用无法启动了，然后找catalina.out日志，但最后也没有定位根本原因是什么，就是因为我们找的日志不对。但有的时候catalina.out里也有我们想要的日志，那是因为我们的应用或使用的一些组件自己捕获了异常，然后将其打印了，这个时候如果恰好这些日志被我们配置成输出到console，则这些日志也会在catalina.out里出现了。

### manager.log和 host-manager.log ###

这几种日志用的比较少，如果需要的化可以这样配置：

handlers = 1catalina.org.apache.juli.FileHandler, 2localhost.org.apache.juli.FileHandler,
    3manager.org.apache.juli.FileHandler, 4host-manager.org.apache.juli.FileHandler, java.util.logging.ConsoleHandler
    
    3manager.org.apache.juli.FileHandler.level = FINE
    3manager.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
    3manager.org.apache.juli.FileHandler.prefix = manager.
    
    4host-manager.org.apache.juli.FileHandler.level = FINE
    4host-manager.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
    4host-manager.org.apache.juli.FileHandler.prefix = host-manager.
    
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].level = INFO
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].handlers = 3manager.org.apache.juli.FileHandler
    
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/host-manager].level = INFO
    org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/host-manager].handlers = 4host-manager.org.apache.juli.FileHandler

### localhost\_access\_log ###

该日志可在Tomcat\\conf的server.xml里Host标签里面配置

可以利用这个日志查询访问最耗时的接口

## 总结 ##

catalina.out即标准输出和标准出错，这里包含tomcat运行自己输出的日志以及程序向控制台输出的日志，一般程序错误我们都能在这里面找到。  
catalina.log是tomcat自己运行的一些日志，这些日志还会输出到catalina.out，但是应用向控制台输出的日志不会输出到catalina.log里。  
localhost.log主要是应用初始化(listener, filter, servlet)未处理的异常最后被tomcat捕获而输出的日志，而这些未处理异常最终会导致应用无法启动。

一般情况下Catalina.out文件是比较大的，可能几百兆甚至几十G，对于查找问题特别不方便，所以我们可以将ConsoleAppender的日志级别直接配成ERROR级，或者单独配个appender来记录ERROR日志，以便有问题时我们可以迅速查找对应日志。

[Alt text]: /images/20211223/2e4469ca5570443eaed694298eb899a2.png