Tomcat生成日志的配置问题

Posted 2023-04-13

<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. &<60; 想配置访问日志？这就必须得写成这样。

directory
这个东西是日志文件放置的目录，在tomcat下面有个logs文件夹，那里面是专门放置日志文件的，当然你也可以修改，我就给改成了D:\

prefix
这个是日志文件的名称前缀，我的日志名称为localhost_access_log.2007-09-22.txt，前面的前缀就是这个localhost_access_log

suffix
这就是后缀名啦，可以改成别的

pattern
这个是最主要的参数了，具体的咱们下面讲，这个参数的内容比较丰富。

resolveHosts
如果这个值是true的话，tomcat会将这个服务器IP地址通过DNS转换为主机名，如果是false，就直接写服务器IP地址啦

还有一些参数：

rotatable
默认为true，默认的设置使得你的tomcat生成的文件命为prefix（前缀）+.+时间（一般是按天算）+.+suffix（后缀），参照我的日志名就知道了：localhost_access_log.2007-09-22.txt
使用这个需要谨慎，因为你将其设置为false的话，tomcat会忽略时间，不会新生成文件，最后导致你的文件超级大，这样生成的文件名就是：localhost_access_log.txt

condition
这个参数不太实用，可以设置任何值，比如咱们设置成condition="tkq"，那么只有当ServletRequest.getAttribute("tkq")为空的时候，才会被记录下来

fileDateFormat
最后的一个参数，很明白，这就是时间格式嘛，但是这个时间格式是针对日志文件起作用的，还记得咱们生成的日志文件全名么：localhost_access_log.2007-09-22.txt，这里面的2007-09-22就是这么来的，如果你想让tomcat每小时生成一个日志文件，也很简单，将这个值设置为：fileDateFormat="yyyy-MM-dd.HH"，当然也可以按分钟生成什么的，自己改改吧

上面是所有的9个参数，刚才咱们说了，pattern这个参数的值比较多，咱们拿下来单独说：
pattern可以设置成两种方式，第一种是pattern="common"，第二种是pattern="combined"
这就可以控制日志里面的格式，各位说了，pattern就这两种？common和combined又是什么意

思，具体是什么格式呢？
别着急，咱们一点一点看，其实pattern是可以设置的，common和combined只是集成了一些显

示方式，就是将显示方式给组合了，pattern的实际值有如下几种，都是后面一个字母，前面

一个%百分号
咱们先贴出来我的日志里面的一条记录，对应着看

127.0.0.1 192.168.254.108 - -1 127.0.0.1 HTTP/1.1 - GET 80&<60; GET /rightmainima/leftbott4.swf HTTP/1.1 304 5563A67708646B6AA299C33D59BE132A [22/Sep/2007:10:08:52 +0800] - /rightmainima/leftbott4.swf localhost 0 0.000

%a
这是记录访问者的IP，在日志里是127.0.0.1

%A
这是记录本地服务器的IP，在日志里是192.168.254.108

%b
这是发送信息的字节数，不涵括http头，如果字节数为0的话，显示为-

%B
看tomcat的解释，没看出来与b%的区别，但我这里显示为-1，没想明白，望知道者告知，我把官方解释贴出来吧 Bytes sent, excluding HTTP headers

%h
这个就是服务器名称了，如果resolveHosts为false的话，这里就是IP地址了，我的日志里是127.0.0.1

%H
访问者使用的协议，这里是HTTP/1.1

%l
这个也不太清楚，官方也说这个always return '-' 官方解释：Remote logical username from identd (可能这样翻译：记录浏览者进行身份验证时提供的名字)(always returns '-')

%m
访问的方式，是GET还是POST，我这是GET

%p
本地接收访问的端口，呵呵，我这里是80啦

%q
比如你访问的是aaa.jsp?bbb=ccc，那么这里就显示?bbb=ccc，明白了吧，这个q是querystring的意思

%r
官方解释：First line of the request (method and request URI)，不是很明白

%s
这个是http的状态，我这里返回的是304，咱们经常看见访问某个网页报错误500什么的，那也会返回500

%S
用户的session ID,这个session ID大家可以另外查一下详细的解释，反正每次都会生成不同的session ID

%t
这就是时间啦，好像有一个Common Log Format可以改，不过我没找到

%u
得到了验证的访问者，否则就是"-"

%U
访问的URL地址，我这里是/rightmainima/leftbott4.swf

%v
服务器名称，可能就是你url里面写的那个吧，我这里是localhost

%D
官方解释：Time taken to process the request, in millis，应该是访问发生的时间，以毫秒记

%T
官方解释：Time taken to process the request, in seconds，应该是访问发生的时间，以秒记

common的值：%h %l %u %t %r %s %b
combined的值：%h %l %u %t %r %s %b %Refereri %User-Agenti

至于combined的值的最后两个为什么会这样，我也不太清楚…

这就是所有的参数了，欢迎交流探讨！
这是官方的解释地址：http://tomcat.apache.org/tomcat-5.5-doc/config/valve.html
这个也可以看一看做参考：http://tomcat.apache.org/tomcat-5.0-doc/config/logger.html
还有这个：http://tomcat.apache.org/tomcat-5.0-doc/config/host.html

Apache官方对Tomcat访问日志的配置介绍的并不详细，大家可以参考Apache（web server）的访问日志，两者有相当多相似的地方 参考技术A 在server.xml里的<host>标签下加上
<Valve className="org.apache.catalina.valves.AccessLogValve"
directory="logs" prefix="localhost_access_log." suffix=".txt"
pattern="common" resolveHosts="false"/>追问

谢谢你，刚才我没描述清楚，我补充问题了。

追答

.....

追问

我怎么看不到补充问题的内容。。
难道度娘给拿走了？

能否加QQ聊，呵呵

追答

不知道，其实你在这上面问不如去一下百度搜索，我就是看那里的。不用非得提问。像如果你提问的比如网站方面就不如去：w3cschool上去看一下

参考技术B 你是想让tomcat控制台上的信息生成日志，保存在文件中吗？追问

我想配置logging.properties或者什么配置文件（*.bat除外），达到改变日志输出级别和输出方式的改变。嘿嘿，能否详细讲解一下这个配置文件？

追答

你可以自己上网“Log4j与common-logging - OPEN开源论坛.mht",我对这个也不太了解。

spring boot框架下如何过滤tomcat生成的访问日志

【中文标题】spring boot框架下如何过滤tomcat生成的访问日志

【英文标题】：How to filter access logs generated by tomcat under spring boot framework

【发布时间】：2016-06-13 09:10:00

【问题描述】：

我们使用的是spring boot框架，通过内嵌的tomcat生成访问日志，访问日志的格式如下：

server.tomcat.access-log-enabled=true
server.tomcat.access-log-pattern="%h %l %u %t '%r' %s %b %D"
server.tomcat.basedir=/data/logs/Waijule/SchoolService/access

幸运的是，生成的访问日志成功，我们得到了肯定的结果：

"127.0.0.1 - - [01/Mar/2016:11:25:47 +0800] 'POST /school-svc/index-summary HTTP/1.1' 200 127 21"
"127.0.0.1 - - [01/Mar/2016:11:25:47 +0800] 'POST /school-svc/wechat/signature/get HTTP/1.1' 200 238 9"
"127.0.0.1 - - [01/Mar/2016:11:25:47 +0800] 'POST /school-svc/wechat/ticket/get HTTP/1.1' 200 225 148"

为了确保服务健康，我们保持每 5 秒运行一次健康检查，我们要过滤的请求以便我们可以得到清晰的访问日志，健康检查 url 就像示例：

"127.0.0.1 - - [01/Mar/2016:12:04:10 +0800] 'GET /school-svc/isHealth HTTP/1.1' 200 6 104"

如何过滤健康检查请求？

感谢您的帮助。

---

根据documentation on access loging，我尝试使用conditionIf来解决问题，在我们的spring框架中，我尝试重写EmbeddedServletContainerCustomizer类中的customize函数，以便可以设置conditionIf，我们的实现喜欢以下示例：

 @Configuration
 public class Application implements EmbeddedServletContainerCustomizer 
     @Override
     public void customize(ConfigurableEmbeddedServletContainer container)
     
         if (container instanceof TomcatEmbeddedServletContainerFactory)
            
                log.debug("It is TomcatEmbeddedServletContainerFactory");
                TomcatEmbeddedServletContainerFactory factory = (TomcatEmbeddedServletContainerFactory) container;
                AccessLogValve accessLogValve = new AccessLogValve();                    
                accessLogValve.setConditionIf("ignore");
                factory.addContextValves(accessLogValve);
            
            else
            
                log.error("WARNING! this customizer does not support your configured container");
            
          

在我的理解中，下一步我们需要做的是设置属性参数，所以我在上面的健康检查控制器上写了拦截器，实现是这样的：

@Component
@Aspect
public class HealthCheckInterceptor

    @Before("execution(* com.waijule.home.controller.HealthCheckController.process(..))")
    private void beforeGetHomeDetailByHomeIdWithTry(JoinPoint joinPoint)
    
        try
        
            Object[] args = joinPoint.getArgs();
            Prediction.checkTrue(args[0] instanceof HttpServletRequest);
            HttpServletRequest request = (HttpServletRequest) args[0];
            request.setAttribute("ignore", "true");
        
        catch (Exception e)
        
            log.error(e.getMessage());
        
    

最后，检查 RequestServlet 的属性（“ignore”）是否被评估。

@RestController
@RequestMapping(value =  "/home-svc/isHealth" , method =  RequestMethod.GET, RequestMethod.HEAD )
public class HealthCheckController

    private String HEALTH = "health";

    @RequestMapping
    public String process(HttpServletRequest request)
    
        log.debug("ignore attribute is ", request.getAttribute("ignore"));
        return HEALTH;
    

输出：忽略属性为真

但是，访问日志中仍然可以找到健康检查的访问通知：

"127.0.0.1 - - [03/Mar/2016:11:34:00 +0800] 'GET /home-svc/isHealth HTTP/1.1' 200 6 120"

我认为属性参数“忽略”是在过程后期设置的，何时以及如何为 HttpServletRequest 设置属性？

如果我们的假设不正确，是什么导致操作不起作用？

感谢您的帮助。

【问题讨论】：

你读过Tomcat的documentation on access loging，尤其是condition的三个属性吗？这应该为您指明正确的方向。

@AndyWilkinson，我听从了你的建议，遇到了一些困难。我记录在下一个模块中，重点关注第一个答案。谢谢。

我尝试了提到的确切步骤，并且效果很好。我认为使用 setConditionIf 而不是 setConditionUnless 的解决方案存在拼写错误。即使使用了 setConditionUnless，我也不需要拦截器，我可以在方法调用本身中设置属性。

另外，我没有创建新的 AccessLogValue，而是获取了现有的 AccessLogValue 并更改了它的属性。这有助于确保我也可以从应用程序属性中设置值。

【参考方案1】：

正如对这个问题Exclude certain requests from Tomcat's log 的回复https://***.com/a/55569199/3346298 所建议的，您应该使用过滤器并将此过滤器添加到filterChain，而不是通过AOP 添加它。

出于同样的原因，似乎在执行 AOP 方面之前检查了日志/非日志功能。

PD：抱歉回复晚了