Java?gRPC攔截器如何實現分布式日志鏈路追蹤器

這篇文章主要介紹“Java gRPC攔截器如何實現分布式日志鏈路追蹤器”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“Java gRPC攔截器如何實現分布式日志鏈路追蹤器”文章能幫助大家解決問題。

跨進程鏈路追蹤原理

想要實現跨進程間的分布式鏈路追蹤，就要在發起遠程調用的時候通過請求頭或者公共的自定義域將鏈路參數放進去，然后服務端收到請求后將鏈路參數從請求頭或者自定義域中或取出來，就這樣一層一層的將鏈路參數傳遞下去直至調用結束。

JAVA的gRPC庫io.grpc提供了在RPC調用中客戶端和服務端的攔截器（Interceptor），通過客戶端攔截器我們可以將鏈路追蹤的參數放到gRPC調用的Metadata中，通過服務端攔截器能夠從Metadata中獲取到鏈路追蹤所傳遞的參數；io.grpc提供的客戶端攔截器和服務端攔截器分別是io.grpc.ClientInterceptor和io.grpc.ServerInterceptor。

代碼實現

maven依賴

    <dependencies>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-all</artifactId>
            <version>${grpc.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-server-spring-boot-starter</artifactId>
            <version>${grpc.starter.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-client-spring-boot-starter</artifactId>
            <version>${grpc.starter.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>io.github.redick01</groupId>
            <artifactId>log-helper-spring-boot-starter-common</artifactId>
            <version>1.0.3-RELEASE</version>
        </dependency>
    </dependencies>

攔截器實現

@Slf4j
@GrpcGlobalClientInterceptor
@GrpcGlobalServerInterceptor
public class GrpcInterceptor extends AbstractInterceptor implements ServerInterceptor, ClientInterceptor {
    // 鏈路追蹤參數traceId
    private static final Metadata.Key<String> TRACE = Metadata.Key.of("traceId", Metadata.ASCII_STRING_MARSHALLER)
    // 鏈路追蹤參數spanId
    private static final Metadata.Key<String> SPAN = Metadata.Key.of("spanId", Metadata.ASCII_STRING_MARSHALLER);
    // 鏈路追蹤參數parentId
    private static final Metadata.Key<String> PARENT = Metadata.Key.of("parentId", Metadata.ASCII_STRING_MARSHALLER);
    @Override
    public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
            MethodDescriptor<ReqT, RespT> methodDescriptor, CallOptions callOptions,
            Channel channel) {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        try {
            return new ForwardingClientCall.SimpleForwardingClientCall<ReqT, RespT>(channel.newCall(methodDescriptor, callOptions)) {
                @Override
                public void start(Listener<RespT> responseListener, Metadata headers) {
                    // 客戶端傳遞鏈路追中數據，將數據放到headers中
                    String traceId = traceId();
                    if (StringUtils.isNotBlank(traceId)) {
                        headers.put(TRACE, traceId);
                        headers.put(SPAN, spanId());
                        headers.put(PARENT, parentId());
                    }
                    // 繼續下一步
                    super.start(new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>(responseListener) {
                        @Override
                        public void onHeaders(Metadata headers) {
                            // 服務端傳遞回來的header
                            super.onHeaders(headers);
                        }
                    }, headers);
                }
            };
        } finally {
            stopWatch.stop();
            log.info(LogUtil.marker(stopWatch.getTime()), "GRPC調用耗時");
        }
    }
    @Override
    public <ReqT, RespT> Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> serverCall,
            Metadata headers, ServerCallHandler<ReqT, RespT> serverCallHandler) {
        // 服務端從headers中獲取到鏈路追蹤參數
        String traceId = headers.get(TRACE);
        String spanId = headers.get(SPAN);
        String parentId = headers.get(PARENT);
        // 構建當前進程的鏈路追蹤數據并體現在日志中
        Tracer.trace(traceId, spanId, parentId);
        log.info(LogUtil.marker(), "開始處理");
        return serverCallHandler.startCall(new ForwardingServerCall.SimpleForwardingServerCall<ReqT, RespT>(serverCall) {
            @Override
            public void sendHeaders(Metadata responseHeaders) {
                super.sendHeaders(responseHeaders);
            }
            @Override
            public void close(Status status, Metadata trailers) {
                super.close(status, trailers);
            }
        }, headers);
    }
}

客戶端使用

客戶端使用代碼如下，該使用示例是在我開源的日志工具中的例子，我這里通過springboot自動裝配將GrpcInterceptor交由spring容器管理。所以可以直接通過自動注入的方式使用。

@RestController
public class TestController {
    @GrpcClient("userClient")
    private UserServiceGrpc.UserServiceBlockingStub userService;
    @Autowired
    private GrpcInterceptor grpcInterceptor;
    //@LogMarker(businessDescription = "獲取用戶名")
    @GetMapping("/getUser")
    public String getUser()     {
        User user = User.newBuilder()
                .setUserId(100)
                .putHobbys("pingpong", "play pingpong")
                .setCode(200)
                .build();
        Channel channel = ClientInterceptors.intercept(userService.getChannel(), grpcInterceptor);
        userService = UserServiceGrpc.newBlockingStub(channel);
        User u = userService.getUser(user);
        return u.getName();
    }
}

關于“Java gRPC攔截器如何實現分布式日志鏈路追蹤器”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。