Spring Cloud Gateway：全方位日志级别链路追踪秘籍

2022-11-14 17:16:07

通过 Spring Cloud Gateway 实现分布式系统中的日志级别链路追踪

在现代分布式系统中，日志级别链路追踪至关重要，它能帮助你快速定位问题、分析性能并优化系统。Spring Cloud Gateway 作为一款强大的 API 网关，提供了丰富的过滤器机制，可以轻松实现链路参数传递，完成日志级别链路追踪以及转发接口耗时计算。

Spring Cloud Gateway 的过滤器机制

Spring Cloud Gateway 的过滤器机制允许你在请求被路由到后端服务之前或之后执行自定义操作。内置过滤器包括 RequestSizeFilter 和 HystrixFilter，还支持自定义过滤器。

日志级别链路追踪

自定义一个过滤器并添加日志记录代码即可实现日志级别链路追踪。该过滤器将记录请求的 URL、方法、参数、耗时等信息，存储在日志文件中。发生问题时，查看日志文件可以快速定位问题所在。

// 示例代码：LogFilter.java
@Component
public class LogFilter extends GatewayFilter {

    private static final Logger logger = LoggerFactory.getLogger(LogFilter.class);

    @Override
    public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        long startTime = System.currentTimeMillis();
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            long endTime = System.currentTimeMillis();
            logger.info("Request: {}, Method: {}, Params: {}, Time: {}ms",
                    exchange.getRequest().getURI(), exchange.getRequest().getMethod(),
                    exchange.getRequest().getQueryParams(), endTime - startTime);
        }));
    }
}

链路参数传递

通过 ServerWebExchange 对象获取和设置请求属性，可以实现链路参数传递。例如，将请求 ID 作为链路参数传递，以便在不同服务之间追踪同一个请求。

// 示例代码：LogFilter.java (更新)
@Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    String requestId = exchange.getRequest().getHeaders().getFirst("X-Request-Id");
    if (requestId == null) {
        requestId = UUID.randomUUID().toString();
    }
    exchange.getAttributes().put("requestId", requestId);
    return chain.filter(exchange).then(Mono.fromRunnable(() -> {
        logger.info("Request: {}, Method: {}, Params: {}, Time: {}ms, RequestId: {}",
                exchange.getRequest().getURI(), exchange.getRequest().getMethod(),
                exchange.getRequest().getQueryParams(), endTime - startTime, requestId);
    }));
}

转发接口耗时计算

添加计时代码即可计算转发接口的耗时。例如，使用 StopWatch 类记录请求的开始和结束时间，计算出请求的耗时。

// 示例代码：LogFilter.java (更新)
@Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    StopWatch stopWatch = new StopWatch();
    stopWatch.start();
    return chain.filter(exchange).then(Mono.fromRunnable(() -> {
        stopWatch.stop();
        logger.info("Request: {}, Method: {}, Params: {}, Time: {}ms, RequestId: {}",
                exchange.getRequest().getURI(), exchange.getRequest().getMethod(),
                exchange.getRequest().getQueryParams(), stopWatch.getTotalTimeMillis(), requestId);
    }));
}