tomcat访问（access）日志配置、记录Post请求参数

蔚落 2022-05-21 07:16 190阅读 0赞

**一、配置与说明**

tomcat访问日志格式配置，在config/server.xml里Host标签下加上

我们在日志文件中将看到如下文本：

10.217.14.16 - - \[21/Oct/2016:15:48:54 +0800\] “POST /updates/related\_notice\_num.json HTTP/1.0” \[channel=App Store&gid=92391918-2173-4A66-8B31-B2FB3F8FB3DF&os=2&plat=2&sver=10.000000&token=MzM1OTc0MjQ1MkB3ZWliby55bXguY29tfHdlaWJvfDQ5ZGFmMjk0YjQ5YWQxMTZiZjBmYWM4ZDdhYzg3ZWQ0&ua=&ver=4.2.1\] 200 - AllApp/4.2.1 (iPhone; iOS 10.0.2; Scale/3.00) 0.004 91

参数说明：

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

下面着重讲下**pattern**。它的参数比较多。可以设置成common,combined两种格式。

common的值：%h %l %u %t %r %s %b  
combined的值：%h %l %u %t %r %s %b %\{Referer\}i %\{User-Agent\}i        (至于combined的值的最后两个为什么会这样，我也不太清楚)

%a   这是记录访问者的IP，在日志里是127.0.0.1 
         %A   这是记录本地服务器的IP，在日志里是192.168.254.108 
         %b   发送信息的字节数，不包括http头，如果字节数为0的话，显示为- 
         %B   发送信息的字节数，不包括http头。 
         %h   服务器的名称。如果resolveHosts为false的话，这里就是IP地址了，例如我的日志里是10.217.14.16 
         %H   访问者的协议，这里是HTTP/1.0 
         %l   官方解释：Remote logical username from identd (可能这样翻译：记录浏览者进行身份验证时提供的名字)(always returns ‘-‘) 
         %m   访问的方式，是GET还是POST 
         %p   本地接收访问的端口  
         %q   比如你访问的是aaa.jsp?bbb=ccc，那么这里就显示?bbb=ccc，就是querystring的意思 
         %r   First line of the request (method and request URI) 请求的方法和URL 
         %s   http的响应状态码  
         %S   用户的session ID,这个session ID大家可以另外查一下详细的解释，反正每次都会生成不同的session ID 
         %t   请求时间 
         %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，请求消耗的时间，以秒记

附：参考官方文档： http://tomcat.apache.org/tomcat-5.5-doc/config/valve.html

**二、配置打印POST参数**

另外%r参数能打印出请求的url和get参数。如果url指定访问方式是post,post的参数是打印不出来的。当需要打印post参数，该怎么办？

大家注意到我开篇举例Valve配置里的%\{postdata\}r。没错，这个combined格式的patterrn可以实现。但是只在valve里配置这个东东还不够。因为postdata使我们自定义的参数名。需要在request中设置这个值。下面附上设置postdata到request中的代码。

package com.xiaoxiliu 
         
         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; 
         } 
         }

在web.xml中添加配置该filter:

<filter> 
         <filter-name>post-data-dumper-filter </filter-name> 
         <filter-class>com.xiaoxiliu.PostDataDumperFilter </filter-class> 
         </filter> 
         <filter-mapping> 
         <filter-name>post-data-dumper-filter </filter-name> 
         <url-pattern>/* </url-pattern> 
         </filter-mapping>

**三、查询访问最耗时的接口**

这就要用到万能的awk了 我们的日志倒数第二列显示的访问时间。cat logs/localhost\_access\_log.2016-10-25.txt | awk ‘\{print (NF−1)""  ( N F − 1 ) "" 0\}’ | sort -n -r| awk ‘\{ 1="";print  1 ="" ; p r i n t 0\}’  按照倒数第二列由大到小显示接口以及访问时间。这样我们就能找出那些借口耗时较大，然后对其进行优化，提高用户体验。

![Center][]

[Center]: /images/20220521/ba86263c6ba44ee8b0b6bb587853d229.png