Tomcat日志

1 Tomcat 日志概述

Tomcat 日志分为下面５类：

1. catalina：Cataline引擎的日志文件，文件名catalina.日期.log
2. localhost：Tomcat下内部代码丢出的日志，文件名localhost.日期.log
3. manager：Tomcat下默认管理应用日志，文件名manager.日期.log
4. host-manager：虚拟主机方面
   (1~4 以上默认开启的，都可以在日志目录下的${catalina}/conf/logging.properties 文件中编辑 . 注 :${catalina} 是 tomcat 的安装目录)
5. Access：访问日志（默认关闭，需要到配置文件中的${catalina}/conf/server.xml中配置）

每类日志的级别分为如下 7 种：
    SEVERE (highest value) > WARNING > INFO > CONFIG > FINE > FINER > FINEST (lowest value) ;
     ALL:所有日志均输出; OFF:禁用日志输出.

2 Tomcat 日志配置

2.1 catalina localhost manager host-manager的日志的配置

一般情况下无需配置，在${catalina}/conf/logging.properties 文件中编辑 . 注 :${catalina} 是 tomcat 的安装目录)
例如catalina的配置：可以修改 日志级别、路径、前缀

1catalina.org.apache.juli.AsyncFileHandler.level = FINE
1catalina.org.apache.juli.AsyncFileHandler.directory = ${catalina.base}/logs
1catalina.org.apache.juli.AsyncFileHandler.prefix = catalina.

注 :${catalina.base}是每个Tomcat目录私有信息的位置，就是conf、logs、temp、webapps和work的父目录。

2.2 访问日志Access的配置

默认 tomcat 不记录访问日志，如下方法可以使 tomcat 记录访问日志

编辑 ${catalina}/conf/server.xml 文件 . 注 :${catalina} 是 tomcat 的安装目录

把以下的注释去掉即可。

 <!--
        <Valve className="org.apache.catalina.valves.AccessLogValve"
         directory="logs"  prefix="localhost_access_log." suffix=".txt"
         pattern="common" resolveHosts="false"/>
  -->

参数说明：

参数名	解释
className	官方文档上说了：This MUST be set to org.apache.catalina.valves.AccessLogValve to use the default access log valve。
directory	日志文件存放的目录。通常设置为tomcat下已有的那个logs文件。
prefix	日志文件的名称前缀。
suffix	日志文件的名称后缀。
pattern	最主要的参数。下面会细讲。
resolveHosts	默认false，直接写服务器IP地址啦，如果是true，tomcat会将这个服务器IP地址通过DNS转换为主机名；
rotatable	默认为true，tomcat生成的文件名为prefix（前缀）.时间（一般是按天算）.suffix（后缀），如：localhost_access_log.2018-09-22.txt。设置为false的话，tomcat会忽略时间，不会生成新文件，文件名就是：localhost_access_log.txt。长此以往，这个日志文件会超级大
condition	这个参数不太实用，可设置任何值，比如设置成condition=”tkq”，那么只有当ServletRequest.getAttribute(“tkq”)为空的时候，该条日志才会被记录下来。
fileDateFormat	顾名思义，就是时间格式嘛。但这个时间格式是针对日志文件名起作用的。咱们生成的日志文件全名：localhost_access_log.2016-09-22.txt，这里面的2016-09-22就是这么来的。如果想让tomcat每小时生成一个日志文件，也很简单，将这个值设置为：fileDateFormat=”yyyy-MM-dd.HH”，当然也可以按分钟生成什么的，自己改改吧^_^

pattern

该项值可以为： common 与 combined ，这两个 预 先 设 置好的 格式对应的日志输出内容如下：
自由组合，例如
common 的值： %h %l %u %t %r %s %b
combined 的值： %h %l %u %t %r %s %b %{Referer}i %{User-Agent}i

参数名	解释
%a	远端IP地址
%A	本地IP地址
%b	发送的字节数，不包括HTTP头，如果为0，使用”－”
%B	发送的字节数，不包括HTTP头
%h	远端主机名(如果resolveHost=false，远端的IP地址）
%H	请求协议
%l	(小写的L)- 从identd返回的远端逻辑用户名（总是返回 ‘-‘）
%m	请求的方法（GET，POST，等）
%p	收到请求的本地端口号
%q	查询字符串(如果存在，以 ‘?’开始)
%r	请求的第一行，包含了请求的方法和URI
%s	响应的状态码
%S	用户的session ID
%t	日志和时间，使用通常的Log格式
%u	认证以后的远端用户（如果存在的话，否则为’-‘）
%U	请求的URI路径
%v	本地服务器的名称
%D	处理请求的时间，以毫秒为单位
%T	处理请求的时间，以秒为单位
另外还可以将cookie, 客户端请求中带的HTTP头(incoming header), 会话(session)或是ServletRequest中的数据都写到Tomcat的访问日志中，你可以用下面的语法来引用。	如下
%{xxx}c	记录特定的cookie xxx
％{xxx}o	记录响应头xxx(Http Resonse)
%{xxx}i	记录客户端请求中带的HTTP头xxx(incoming headers) ，例如：%{Referer}i从哪个页面链接跳转到的此页面，%{User-agent}：i用户的User-Agent
%{xxx}s	记录HttpSession中的xxx属性(attribute)。
%{xxx}r	记录ServletRequest中的xxx属性(attribute)，xxx是我们自定义的参数名，需要在request中设置这个值request.setAttribute

配置获取POST参数

    上面提到的%r参数能打印出请求的url和get参数。如果url指定访问方式是post,post的参数是打印不出来的。当需要打印post参数，该怎么办？———使用%{xxx}r
例如配置%{postdata}r，因为postdata使我们自定义的参数名。所以需要在request中设置这个值。下面附上设置postdata到request中的代码。

import java.io.IOException;
import java.util.Enumeration;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public final class PostDataDumperFilter implements Filter {

    Logger logger = LoggerFactory.getLogger(getClass());

    private FilterConfig filterConfig = null;

    public void destroy() {
        this.filterConfig = null;
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        if (filterConfig == null)
            return;

        Enumeration<String> names = request.getParameterNames();
        StringBuilder output = new StringBuilder();
        while (names.hasMoreElements()) {
            String name = (String) names.nextElement();
            output.append(name).append("=");
            String values[] = request.getParameterValues(name);
            for (int i = 0; i < values.length; i++) {
                if (i > 0) {
                    output.append("' ");
                }

                output.append(values[i]);
            }
            if (names.hasMoreElements())
                output.append("&");
        }
        request.setAttribute("postdata", output);
        logger.debug("postdata: " + output);
        chain.doFilter(request, response);
    }

    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
    }
}

如果觉得Tomcat的日志不够好，也可以让 apache tomcat 使用 log4j 管理日志，而且有时候还能更清楚的知道为什么有些应用启动不成功，日志可以查的很清楚。