在gRPC微服务中传递Serilog的CorrelationId

概述

在分布式微服务架构中，追踪请求的完整调用链是排查问题的关键。本文将介绍如何在基于gRPC的微服务系统中，通过HTTP请求头传递Serilog的CorrelationId，实现跨服务的调用追踪。

核心概念

CorrelationId的作用

CorrelationId是一个唯一标识符，用于跟踪一个请求在多个服务间的流转过程。它可以帮助开发者在日志系统中快速定位完整的调用链路。

gRPC元数据

gRPC提供了Metadata机制，允许在请求和响应中传递额外的键值对信息，非常适合用于传递CorrelationId这类追踪信息。

实现方案

1. 服务端拦截器实现

在服务端，我们需要创建一个拦截器来接收并处理客户端传递的CorrelationId：

public class GrpcServerLoggerInterceptor : Interceptor
{
    public override async Task<TResponse> UnaryServerHandler<TRequest, TResponse>(
        TRequest request, 
        ServerCallContext context, 
        UnaryServerMethod<TRequest, TResponse> continuation)
    {
        // 从gRPC元数据中获取CorrelationId
        var correlationIdHeader = context.RequestHeaders
            .FirstOrDefault(m => string.Equals(m.Key, "x-correlation-id", StringComparison.Ordinal));
        
        // 如果没有则生成新的ID
        var correlationId = correlationIdHeader?.Value ?? Guid.NewGuid().ToString();
        
        // 将CorrelationId推入日志上下文
        using (LogContext.PushProperty("x-correlation-id", correlationId))
        {
            return await base.UnaryServerHandler(request, context, continuation);
        }
    }
}

2. 客户端拦截器实现

客户端拦截器需要从HTTP上下文中获取CorrelationId并注入到gRPC调用中：

public class GrpcClientLoggerInterceptor : Interceptor
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public GrpcClientLoggerInterceptor(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public override AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>(
        TRequest request,
        ClientInterceptorContext<TRequest, TResponse> context,
        AsyncUnaryCallContinuation<TRequest, TResponse> continuation)
    {
        // 从HTTP上下文中获取CorrelationId
        var correlationId = _httpContextAccessor.HttpContext?.Request.Headers["x-correlation-id"]
            .FirstOrDefault() ?? Guid.NewGuid().ToString();
        
        // 创建包含CorrelationId的元数据
        var metadata = new Metadata
        {
            { "x-correlation-id", correlationId }
        };

        // 合并现有元数据
        var newContext = new ClientInterceptorContext<TRequest, TResponse>(
            context.Method,
            context.Host,
            context.Options.WithHeaders(
                (context.Options.Headers ?? new Metadata()).Aggregate(
                    metadata,
                    AddIfNonExistent))
        );

        return continuation(request, newContext);
    }

    private static Metadata AddIfNonExistent(Metadata metadata, Metadata.Entry entry)
    {
        if (metadata.Get(entry.Key) == null) 
            metadata.Add(entry);
        return metadata;
    }
}

3. 注册拦截器

在服务启动时注册拦截器：

services.AddGrpcClient<MyGrpcClient>(opts =>
{
    opts.Address = new Uri("https://service-b");
    opts.InterceptorRegistrations.Add(new InterceptorRegistration(
        InterceptorScope.Client,
        s =>
        {
            var accessor = s.GetRequiredService<IHttpContextAccessor>();
            return new GrpcClientLoggerInterceptor(accessor);
        }));
});

最佳实践

1. 统一命名规范：建议团队统一CorrelationId的头部名称，如"x-correlation-id"。

2. ID生成策略：当请求头中不存在CorrelationId时，应该生成一个新的唯一标识符。

3. 日志上下文：使用Serilog的LogContext确保CorrelationId自动出现在所有相关日志中。

4. 性能考虑：拦截器会被频繁调用，应确保其逻辑尽可能高效。

扩展思考

这种模式不仅适用于CorrelationId，还可以扩展到其他需要在服务间传递的上下文信息，如：

• 用户标识信息
• 请求来源标识
• 业务上下文信息

通过gRPC拦截器机制，我们可以实现透明的上下文传递，而不需要修改业务代码，这是微服务架构中非常有力的工具。