用微服务-网关Spring Gateway进阶，轻松追踪日志！

微服务日志追踪之 Spring Gateway 进阶指南

前言

微服务架构的复杂性使得日志追踪至关重要。它可以帮助我们轻松关联分散的日志，迅速排查问题。Spring Gateway 作为一款强大网关，提供丰富的日志追踪功能。本文将深入探讨如何利用 Spring Gateway 实现高效的日志追踪。

日志追踪：统一请求日志

日志追踪通过为每个请求添加一个统一标识（traceId）来关联日志信息。traceId 可由服务端或客户端生成，并在后续请求中传递。这样，所有相关日志都带有相同的 traceId，方便定位和排查。

Spring Gateway 日志追踪实践

添加依赖

在 Spring Gateway 应用中添加日志追踪依赖：

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>

配置日志追踪

在 application.yml 中配置日志追踪：

spring:
  sleuth:
    enabled: true
    sampler:
      probability: 1.0

这将启用日志追踪并设置采样率为 100%。

自动生成 traceId

Spring Gateway 会自动为每个请求生成 traceId，并将其添加到日志信息中。

日志收集和查看

使用日志工具（如 ELK Stack）收集和查看带有 traceId 的日志信息。通过 traceId 即可快速找到相关日志。

自定义 traceId 生成策略

Spring Gateway 支持自定义 traceId 生成策略。在 application.yml 中设置 spring.sleuth.traceIdGenerator 属性，指定自定义类。

spring:
  sleuth:
    traceIdGenerator: com.example.CustomTraceIdGenerator

代码示例

以下代码示例展示了如何使用 Spring Gateway 日志追踪：

@RestController
public class TestController {

    @GetMapping("/test")
    public String test(@RequestHeader("traceId") String traceId) {
        // 输出 traceId
        System.out.println("TraceId: " + traceId);
        return "Hello world!";
    }
}

结论

Spring Gateway 的日志追踪功能为微服务应用运维提供了强大的工具。通过关联分散的日志，我们可以快速定位和排查问题，大幅提高效率。

常见问题解答

1. 如何禁用 Spring Gateway 的日志追踪？

修改 application.yml 配置：

spring:
  sleuth:
    enabled: false

2. 如何修改日志追踪采样率？

修改 application.yml 配置：

spring:
  sleuth:
    sampler:
      probability: 0.5

3. 如何使用自定义 traceId 生成器？

在 application.yml 中设置 spring.sleuth.traceIdGenerator 属性，指定自定义类。

4. 如何在请求头中获得 traceId？

使用 @RequestHeader("traceId") String traceId 注解。

5. 如何收集和查看带有 traceId 的日志？

使用日志工具（如 ELK Stack），配置 traceId 字段。