如何使用 springboot 微服务获得用于跟踪的 req id？

Question

问题是：

每当客户端调用 API 时，我都想用唯一标识符标记它或使用客户端提供的标识符（通常在查询参数中）并将其传递到组件之间，直到成功完成请求或失败。 目标是全面了解不同组件如何处理请求以及每个组件发生了什么，并快速识别问题。

我如何使用 springboot 微服务实现这一点。 请帮我。

Answer 1

Spring Cloud Sleuth 就是你要找的： https://cloud.spring.io/spring-cloud-sleuth/reference/html/

Spring Cloud Sleuth 的解决方案是将跨度和跟踪 ID 注入日志条目。 跟踪 ID 是整个请求流将共享的唯一标识符。 IA 跨度更本地化，并且针对每个请求发送事件收到的每个请求进行定义。 它们定义特定的交互点。

当从分布式系统外部接收到客户端请求时，会生成初始跨度或根跨度。 此请求缺少跟踪和跨度信息。 根跨度成为通过系统的请求流的 rest 的跟踪 ID。

下图显示了 Sleuth 跨度和跟踪生成如何通过假设的 service.network 工作。

您需要在代码中做的就是添加依赖项spring-cloud-starter-sleuth sleuth，Spring 将自动检测以下通信渠道：

• 通过消息技术请求，如 Apache Kafka 或 RabbitMQ
• HTTP 标头在 Spring MVC 控制器处收到
• 使用 RestTemplate 发出的请求

Answer 2

如果您想从简单开始，您可以定义一个过滤器（例如，通过扩展OncePerRequestFilter ）来生成/提取请求 ID。 您还可以将它放入 Logback 的MDC中，以便它包含在从执行请求的线程发出的每个日志记录语句中（如果已配置）：

@Component
public class RequestIdFilter extends OncePerRequestFilter {

    private final ThreadLocal<String> requestId = new ThreadLocal<>();

    public Optional<String> getCurrentRequestId() {
        return Optional.ofNullable(requestId.get());
    }
    
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws ServletException, IOException {
        try {
            requestId.set(UUID.randomUUID().toString()); // or extract from request
            MDC.put("requestId", requestId.get());
            chain.doFilter(request, response);
        } finally {
            requestId.remove();
        }
    }
}