Spring Cloud 升级之路 - 2020.0.x - 3. Undertow 的 accesslog 配置

上一节我们讲述了如何使用 Undertow 作为我们的 Web 服务容器,本小节我们来分析使用 Undertow 的另一个问题,也就是如何配置 accesslog,以及 accesslog 的各种占位符。

accesslog 相关配置 server: undertow: # access log相关配置 accesslog: # 存放目录,默认为 logs dir: ./log # 是否开启 enabled: true # 格式,各种占位符后面会详细说明 pattern: '{ "transportProtocol":"%{TRANSPORT_PROTOCOL}", "scheme":"%{SCHEME}", "protocol":"%{PROTOCOL}", "method":"%{METHOD}", "reqHeaderUserAgent":"%{i,User-Agent}", "cookieUserId": "%{c,userId}", "queryTest": "%{q,test}", "queryString": "%q", "relativePath": "%R, %{REQUEST_PATH}, %{RESOLVED_PATH}", "requestLine": "%r", "uri": "%U", "thread": "%I", "hostPort": "%{HOST_AND_PORT}", "localIp": "%A", "localPort": "%p", "localServerName": "%v", "remoteIp": "%a", "remoteHost": "%h", "bytesSent": "%b", "time":"%{time,yyyy-MM-dd HH:mm:ss.S}", "status":"%s", "reason":"%{RESPONSE_REASON_PHRASE}", "respHeaderUserSession":"%{o,userSession}", "respCookieUserId":"%{resp-cookie,userId}", "timeUsed":"%Dms, %Ts, %{RESPONSE_TIME}ms, %{RESPONSE_TIME_MICROS} us, %{RESPONSE_TIME_NANOS} ns", }' # 文件前缀,默认为 access_log prefix: access. # 文件后缀,默认为 log suffix: log # 是否另起日志文件写 access log,默认为 true # 目前只能按照日期进行 rotate,一天一个日志文件 rotate: true 注意点 1:日志文件 rotate 目前只能按照日期

Undertow 的 accesslog 处理核心类抽象是 io.undertow.server.handlers.accesslog.AccesslogReceiver。由于目前 Undertow 的 AccesslogReceiver 只有一种实现在使用,也就是 io.undertow.server.handlers.accesslog.DefaultAccessLogReceiver。

查看 DefaultAccessLogReceiver 的 rotate 时机:

DefaultAccessLogReceiver

/** * 计算 rotate 时间点 */ private void calculateChangeOverPoint() { Calendar calendar = Calendar.getInstance(); calendar.set(Calendar.SECOND, 0); calendar.set(Calendar.MINUTE, 0); calendar.set(Calendar.HOUR_OF_DAY, 0); //当前时间日期 + 1,即下一天 calendar.add(Calendar.DATE, 1); SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd", Locale.US); currentDateString = df.format(new Date()); // if there is an existing default log file, use the date last modified instead of the current date if (Files.exists(defaultLogFile)) { try { currentDateString = df.format(new Date(Files.getLastModifiedTime(defaultLogFile).toMillis())); } catch(IOException e){ // ignore. use the current date if exception happens. } } //rotate 时机是下一天的 0 点 changeOverPoint = calendar.getTimeInMillis(); } accesslog 占位符

其实 Undertow 中的 accesslog 占位符,就是之前我们提到的 Undertow Listener 解析请求后抽象的 HTTP server exchange 的属性。

的表格并不是最全的,并且注意点并没有说明,例如某些占位符必须打开某些 Undertow 特性才能使用等等。这里我们列出下。

首先先提出一个注意点,参数占位符,例如 %{i,你要看的header值} 查看 header 的某个 key 的值。逗号后面注意不要有空格,因为这个空格会算入 key 里面导致拿不到你想要的 key

请求相关属性 描述 缩写占位符 全名占位符 参数占位符 源码
请求传输协议,等价于请求协议     %{TRANSPORT_PROTOCOL}     TransportProtocolAttribute  
请求模式,例如 http、https 等     %{SCHEME}     RequestSchemeAttribute  
请求协议,例如 HTTP/1.1 等   %H   %{PROTOCOL}     RequestProtocolAttribute  
请求方法,例如 GET、POST 等   %m   %{METHOD}     RequestMethodAttribute  
请求 Header 的某一个值       %{i,你要看的header值}   RequestHeaderAttribute  
Cookie 的某一个值       %{c,你要看的cookie值} 或者 %{req-cookie,你要看的cookie值}   分别对应 CookieAttribute 和 RequestCookieAttribute  
路径参数 PathVariable 由于并没有被 Undertow 的 Listener 或者 Handler 解析处理,所以拦截不到,无法确认是否是一个 PathVariable 还是就是 url 路径。所以,PathVariable 的占位符是不会起作用的       %{p, 你想查看的路径参数 key }   PathParameterAttribute  
请求参数,即 url 的 ? 之后键值对,这里可以选择查看某个 key 的值。       %{q, 你想查看的请求参数 key}   QueryParameterAttribute  
请求参数字符串,即 url 的 ? 之后的所有字符}   %q(不包含 ?)   %{QUERY_STRING}(不包含 ?);%{BARE_QUERY_STRING}(包含 ?)     QueryStringAttribute  
请求相对路径(在 Spring Boot 环境下,大多数情况 RequestPath 和 RelativePath 还有 ResolvedPath 是等价的),即除去 host,port,请求参数字符串的路径   %R   %{RELATIVE_PATH} 或者 %{REQUEST_PATH} 或者 %{RESOLVED_PATH}     分别对应 RelativePathAttribute 和 RequestPathAttribute 和 ResolvedPathAttribute  
请求整体字符串,包括请求方法,请求相对路径,请求参数字符串,请求协议,例如 Get /test?a=b HTTP/1.1   %r   %{REQUEST_LINE}     RequestLineAttribute  
请求 URI,包括请求相对路径,请求参数字符串   %U   %{REQUEST_URL}     RequestURLAttribute  
处理请求的线程   %I   %{THREAD_NAME}     ThreadNameAttribute  

注意:

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zyfwwz.html