Springcloud Gateway網關日志這樣打才完美

日志打印收集是開發(fā)中調試和定位線上問題的關鍵手段也是重中之重，gateway作為請求入口轉發(fā)的核心模塊，合理、規(guī)范的日志打印很重要。

  • 這里只進行日志的打印輸出，不做收集，收集匯總工作可以結合ELK，監(jiān)控日志文件進行同步。
  • 實現方式使用 gateway 的 GlobalFilter 過濾器。
  • 請求日志打印的過濾器排序盡量低一些。
  • 打印日志時，注意避免多次打印造成并發(fā)請求日志錯亂，可以拼接一個大的日志串，一次打印輸出。

RequestLogFilter

增加一個請求入參過濾器，用來打印入參信息。

@Slf4j
@Configuration
@ConditionalOnProperty(value = "log.request.enabled", havingValue = "true", matchIfMissing = true)
public class RequestLogFilter implements GlobalFilter, Ordered {

   @Override
   public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
      ServerHttpRequest request = exchange.getRequest();
      // 打印請求路徑
      String path = request.getPath().pathWithinApplication().value();
      // 打印請求url
      String requestUrl = this.getOriginalRequestUrl(exchange);

      // **構建成一條長 日志，避免并發(fā)下日志錯亂**
      StringBuilder reqLog = new StringBuilder(200);
      // 日志參數
      List<Object> reqArgs = new ArrayList<>();
      reqLog.append("\n\n================ Gateway Request Start  ================\n");
      // 打印路由添加占位符
      reqLog.append("===> {}: {}\n");
      // 參數
      String requestMethod = request.getMethodValue();
      reqArgs.add(requestMethod);
      reqArgs.add(requestUrl);

      // 打印請求頭
      HttpHeaders headers = request.getHeaders();
      headers.forEach((headerName, headerValue) -> {
         reqLog.append("===Headers===  {}: {}\n");
         reqArgs.add(headerName);
         //如果有token，可以先把token解析后打印出原始報文，JwtUtil替換成自己項目里工具類
         if (AUTH_KEY.toLowerCase().equals(headerName)) {
            String value = headerValue.get(0);
            String token = JwtUtil.getToken(value);
            Claims claims = JwtUtil.parseJWT(token);
            reqArgs.add((claims == null) ? "" : claims.toString());
            reqLog.append("===Headers===  {}: {}\n");
            reqArgs.add(headerName.concat("-original"));
            reqArgs.add(StringUtils.join(headerValue.toArray()));
         } else {
            reqArgs.add(StringUtils.join(headerValue.toArray()));
         }
      });

      reqLog.append("================  Gateway Request End  =================\n");
      // 打印執(zhí)行時間
      log.info(reqLog.toString(), beforeReqArgs.toArray());
      return chain.filter(exchange);
   }
   
    private String getOriginalRequestUrl(ServerWebExchange exchange) {
            ServerHttpRequest request = exchange.getRequest();
            LinkedHashSet<URI> uris = exchange.getRequiredAttribute(ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR);
            URI requestUri = uris.stream().findFirst().orElse(request.getURI());
            MultiValueMap<String, String> queryParams = request.getQueryParams();
            return UriComponentsBuilder.fromPath(requestUri.getRawPath()).queryParams(queryParams).build().toUriString();
    } 

   @Override
   public int getOrder() {
      return Ordered.LOWEST_PRECEDENCE;
   }

ResponseLogFilter

網關請求的響應報文不在這里打印，post body 參數沒有打印

@Slf4j
@Configuration
@ConditionalOnProperty(value = "log.request.enabled", havingValue = "true", matchIfMissing = true)
public class GlobalResponseLogFilter implements GlobalFilter, Ordered {

   @Override
   public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
      ServerHttpRequest request = exchange.getRequest();
      // 打印請求路徑
      String path = request.getPath().pathWithinApplication().value();
      return chain.filter(exchange).then(
         Mono.fromRunnable(() -> {
            MultiValueMap<String, String> queryParams = request.getQueryParams();
            String requestUrl = UriComponentsBuilder.fromPath(path).queryParams(queryParams).build().toUriString();

            // 構建成一條長日志
            StringBuilder responseLog = new StringBuilder(200);
            // 日志參數
            List<Object> responseArgs = new ArrayList<>();
            responseLog.append("\n\n================ Gateway Response Start  ================\n");
            ServerHttpResponse response = exchange.getResponse();
            // 狀態(tài)碼個path占位符: 200 get: /xxx/xxx/xxx?a=b
            responseLog.append("<=== {} {}: {}\n");
            // 參數
            String requestMethod = request.getMethodValue();
            responseArgs.add(response.getStatusCode().value());
            responseArgs.add(requestMethod);
            responseArgs.add(requestUrl);

            // 打印請求頭
            HttpHeaders headers = response.getHeaders();
            headers.forEach((headerName, headerValue) -> {
               responseLog.append("===Headers===  {}: {}\n");
               responseArgs.add(headerName);
               responseArgs.add(StringUtils.join(headerValue.toArray()));
            });

            responseLog.append("================  Gateway Response End  =================\n");
            // 打印執(zhí)行時間
            log.info(responseLog.toString(), responseArgs.toArray());
         })
      );
   }

   @Override
   public int getOrder() {
      return Ordered.HIGHEST_PRECEDENCE;
   }
}

打印完整格式

================ Gateway Request Start  ================
===> GET: /xx/xx/xx/get?scope=1&type=1
===Headers===  Host: xx.xx.xx.com:10001
===Headers===  X-Request-ID: 84cd4a9a6cb67a7c21e1211d7ac8a236
===Headers===  X-Real-IP: 218.29.167.226
===Headers===  X-Forwarded-For: 218.29.167.226
===Headers===  X-Forwarded-Host: xx.xx.xx.com:10001
===Headers===  X-Forwarded-Port: 443
===Headers===  X-Forwarded-Proto: https
===Headers===  X-Forwarded-Scheme: https
===Headers===  X-Scheme: https
===Headers===  sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"
===Headers===  auth-token: {tenant_id=100000, xxx:xxx}
===Headers===  auth-token-original: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRfaWQiOiIwxxx
===Headers===  sec-ch-ua-mobile: ?0
===Headers===  user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36
===Headers===  content-type: application/json;charset=utf-8
===Headers===  accept: application/json, text/plain, */*
===Headers===  tenant-id: 100000
===Headers===  sec-ch-ua-platform: "Windows"
===Headers===  origin: https://xx.xx.xx.com
===Headers===  sec-fetch-site: same-site
===Headers===  sec-fetch-mode: cors
===Headers===  sec-fetch-dest: empty
===Headers===  referer: https://xx.xx.xx.com/
===Headers===  accept-encoding: gzip, deflate, br
===Headers===  accept-language: zh-CN,zh-TW;q=0.9,zh;q=0.8,en-US;q=0.7,en;q=0.6
================  Gateway Request End  =================

================ Gateway Response Start  ================
<=== 200 GET: /xx/xx/xx/get?scope=1&type=1
===Headers===  transfer-encoding: chunked
===Headers===  Access-Control-Allow-Headers: X-Requested-With, Tenant-Id, Auth-Token, Content-Type, Authorization, credential, X-XSRF-TOKEN, token, username, client
===Headers===  Access-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS,HEAD
===Headers===  Access-Control-Allow-Origin: *
===Headers===  Access-Control-Expose-Headers: *
===Headers===  Access-Control-Max-Age: 18000L
===Headers===  Access-Control-Allow-Credentials: true
===Headers===  Content-Type: application/json;charset=UTF-8
===Headers===  Date: Thu, 16 Jun 2022 10:15:24 GMT
================  Gateway Response End  =================
?著作權歸作者所有,轉載或內容合作請聯系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容