添加链接
link之家
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接

日志打印收集是开发中调试和定位线上问题的关键手段也是重中之重,gateway作为请求入口转发的核心模块,合理、规范的日志打印很重要。

  • 这里只进行日志的打印输出,不做收集,收集汇总工作可以结合ELK,监控日志文件进行同步。
  • 实现方式使用 gateway 的 GlobalFilter 过滤器。
  • 请求日志打印的过滤器排序尽量低一些。
  • 打印日志时,注意避免多次打印造成并发请求日志错乱,可以拼接一个大的日志串,一次打印输出。

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);
      // **构建成一条长 日志,避免并发下日志错乱**
      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");
      // 打印执行时间
      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();
            // 状态码个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");
            // 打印执行时间
            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  =================
                    日志打印收集是开发中调试和定位线上问题的关键手段也是重中之重,gateway作为请求入口转发的核心模块,合理、规范的日志打印很重要。增加一个请求入参过滤器,用来打印入参信息。ResponseLogFilter网关请求的响应报文不在这里打印,post body 参数没有打印...
  accesslog :
    enabled : true # enable or disable logging, default value is true.
    timeZone : Asia/Seoul # log datetime zone setting, default is UTC
自定义访问用户信息解析器
 public interface AccessUserInformationResolver {
	String resolveAccessUserInformation ( ServerWebExchange serverWebExchange );
 Acces
Spring Cloud GatewaySpring官网基于Spring 5.0、 Spring Boot 2.0、Project Reactor等技术开发的网关 服务。
Spring Cloud Gateway基于Filter链提供网关基本功能:安全、监控/埋点、限流等。
Spring Cloud Gateway为微服务架构提供简单、有效且统一的API路由管理方式。
Spring Cloud Gat
				
Spring Cloud Gateway 是一个非常流行的微服务网关,在微服务架构设计中有着重要的作用,可以用来实现各种功能,例如路由转发、负载均衡、流量控制、限流等;除此之外,Spring Cloud Gateway 还能够支持统一认证,即只需要一次认证,就能够访问所有的微服务,这对于复杂的微服务架构来说非常的有用。 实现统一认证的实现方法如下: 1. 接入认证中心:首先需要在 Spring Cloud Gateway 中接入一个认证中心,比如使用 Spring Security 或 OAuth2 进行认证,实现单点登录。 2. 统一身份验证:在用户登录认证成功之后,会生成一个 token,Spring Cloud Gateway 会通过这个 token 来进行用户身份认证。而在微服务中,只需要进行简单的 token 验证就能够获取到用户信息,并进行相应的操作。 3. 统一资源管理:在认证中心中进行配置,指定可以访问的资源,进而限制了用户访问微服务的范围。这样就能够确保只有获得了相应权限的用户才能够访问微服务。 4. 日志跟踪:Spring Cloud Gateway 还能够记录每个请求的详细信息和用户信息,进而进行日志跟踪和监控,这对于故障排除和性能优化非常重要。 总之,实现 Spring Cloud Gateway 的统一认证,能够提供更好的安全性,同时提高开发效率,显著降低了微服务的管理难度,减轻了微服务的管理负担。
springboot中logback配置conversionRule、ConsoleAppender|RollingFileAppender、PatternLayoutEncoder、Layout等 Go并发编程 Goroutine、Channel、Select、Mutex锁、sync、Atomic等 Wails + Go 实现图形化桌面应用