如何通过MDC将从JWT获取的用户id添加到后端日志中？

Question

我们有一个带有REST接口的Spring Boot应用程序和一个web客户端。我们使用spring-security和OAuth2.0 JWT令牌进行身份验证。我们正在使用slf4j和sleuth进行日志记录。我们希望在日志中记录当前登录的用户id。技术上，我们希望将用户id添加到服务器应用程序的映射诊断上下文(MDC)中。

spring.sleuth.baggage.remote-fields=user_id
spring.sleuth.baggage.tag-fields=user_id
spring.sleuth.baggage.correlation-fields=user_id

logging:
  level:
    ROOT: WARN
  pattern:
    console: "[%d] [%t] %highlight(%-5p) %c{10} - %cyan([trace=%X{X-B3-TraceId:-} span=%X{X-B3-SpanId:-} user=%X{user_id:-}]) %m%n"

null

package net.company.common.service;

import brave.baggage.BaggageField;
import brave.baggage.BaggagePropagation;
import brave.baggage.BaggagePropagationConfig;
import brave.baggage.BaggagePropagationCustomizer;
import brave.internal.baggage.BaggageContext;
import net.company.common.service.CommonServiceConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@ComponentScan
@Import({CommonServiceConfig.class})
public class ServiceConfig {

  @Bean
  BaggagePropagationConfig.SingleBaggageField singleBaggageField() {
    BaggagePropagationConfig.SingleBaggageField field = BaggagePropagationConfig.SingleBaggageField.newBuilder(BaggageField.create("user_id")).build();
    field.field().updateValue("user_12345"); // set only dummy value for debug
    return field;
  }

}

可以手动实现这样的MDC，请参阅https://www.baeldung.com/mdc-in-log4j-2-logback。但由于这是容易出错的，我们希望避免它，例如，上下文清理必须做正确的。

如何使用sleuth/brave将来自JWT的用户id添加到MDC以进行服务器端日志记录？

Answer 1

我在用

spring boot version: 2.1.2.RELEASE
spring cloud version: Greenwich.RELEASE

并且可以使用以下属性进行配置

spring.sleuth.propagation-keys=user_id
spring.sleuth.log.slf4j.whitelisted-mdc-keys=user_id