springboot+grpc全链路日志追踪

1.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
    <!-- 定义日志文件 名称 -->
    <springProperty scope="context" name="APP_NAME" source="spring.application.name"/>

    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="/data/logs/${APP_NAME}" />

    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <pattern> %d{yyyy-MM-dd HH:mm:ss} %green([%thread]) %highlight(%-5level) %boldMagenta(%logger) [trackId:%X{TRACK_ID}] - %cyan(%msg%n)</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/logback-${APP_NAME}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>180</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern> %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} [trackId:%X{TRACK_ID}]  - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>150MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!--日志级别-->
    <root level="INFO">
        <appender-ref ref="FILE"/>
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

2.trackId放置拦截器，trackId可以由前端传过来这样出问题可以f12拿trackId

@Component
@Slf4j
public class TrackIdInterceptor implements HandlerInterceptor {
  private static final String TRACK_ID = "TRACK_ID";

  @Override
  public boolean preHandle(
      HttpServletRequest request, HttpServletResponse response, Object handler) {
    try {
      // 添加MDC日志(前端传)
      //    String trackId = request.getHeader("TRACK_ID");
      // 后端为每个请求生成
      String trackId = UUID.randomUUID().toString();
      MDC.put(TRACK_ID, trackId);
      return true;
    } catch (Exception e) {
      // 永远放行，不能阻碍请求
      return true;
    }
  }

  @Override
  public void afterCompletion(
      HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
    // 移除MDC日志
    log.info("移除MDC中的trackId: {}", MDC.get("TRACK_ID"));
    MDC.remove(TRACK_ID);
  }
}

注册拦截器：interceptorRegistry.addInterceptor(xxx)

3.grpc客户端拦截器：

@GrpcGlobalClientInterceptor
@Slf4j
public class GrpcClientInterceptor implements ClientInterceptor {
  public GrpcClientInterceptor() {}

  @Override
  public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
      MethodDescriptor<ReqT, RespT> method, CallOptions callOptions, Channel next) {

    return new ForwardingClientCall.SimpleForwardingClientCall<ReqT, RespT>(
        next.newCall(method, callOptions)) {
      @Override
      public void start(Listener<RespT> responseListener, Metadata headers) {
        // 添加traceId
        String trackId = MDC.get("TRACK_ID");
        if (StringUtils.isNotBlank(trackId)) {
          headers.put(Metadata.Key.of("TRACK_ID", Metadata.ASCII_STRING_MARSHALLER), trackId);
        }
        super.start(
            new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>(
                responseListener) {
              @Override
              public void onHeaders(Metadata headers) {
                super.onHeaders(headers);
              }
            },
            headers);
      }
    };
  }
}

4.grpc服务端拦截器

@GrpcGlobalServerInterceptor
@Slf4j
public class GrpcServiceInterceptor implements ServerInterceptor {
  @Override
  public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
      ServerCall<ReqT, RespT> call, Metadata headers, ServerCallHandler<ReqT, RespT> next) {

    // 将trackID放到MDC中
    String trackId =
        headers.get(
            Metadata.Key.of(Constants.CommonConstants.TRACK_ID, Metadata.ASCII_STRING_MARSHALLER));
    MDC.put("TRACK_ID", trackId);
    log.info("客户端请求trackId:{}", trackId);
    ServerCall.Listener<ReqT> listener =
        Contexts.interceptCall(Context.current(), call, headers, next);
    return new ServerCallListenerWithCleanup<>(listener);
  }

  private static class ServerCallListenerWithCleanup<ReqT>
      extends ForwardingServerCallListener.SimpleForwardingServerCallListener<ReqT> {
    ServerCallListenerWithCleanup(ServerCall.Listener<ReqT> delegate) {
      super(delegate);
    }

    @Override
    public void onComplete() {
      try {
        // 请求结束后移除trackID
        log.info("请求结束移除trackId:{}", MDC.get("TRACK_ID"));
        MDC.remove("TRACK_ID");
      } finally {
        super.onComplete();
      }
    }
  }
}

5.据说还有子线程trackId为空的，我还没遇到，遇到了再补上。