如何在.NET Core gRPC服务端传递异常堆栈跟踪？

1. 开启gRPC服务端详细错误配置 #

gRPC默认在非开发环境会隐藏异常详情（包括堆栈），需要显式开启：

// Program.cs 中配置gRPC服务
builder.Services.AddGrpc(options =>
{
    // 开发环境开启详细错误，生产环境建议关闭或限制访问
    options.EnableDetailedErrors = builder.Environment.IsDevelopment();
});

开启后，RpcException会自动携带原始异常的部分详情，但默认仍可能不会完整返回堆栈，需要结合自定义处理。

2. 自定义拦截器，通过元数据传递堆栈信息 #

在ExceptionHandler Interceptor中，将异常堆栈手动添加到gRPC的Metadata（Trailers）中，客户端可通过Trailers获取：

服务端拦截器代码修改 #

catch (Exception ex)
{
    var metadata = new Metadata();
    // 将完整异常信息（含堆栈）存入元数据
    metadata.Add("ExceptionDetails", ex.ToString());
    
    // 抛出RpcException，携带状态码、提示信息和元数据
    throw new RpcException(
        new Status(StatusCode.Internal, "服务内部错误"), 
        metadata
    );
}

客户端获取堆栈信息 #

try
{
    await grpcClient.YourMethodAsync(request);
}
catch (RpcException ex)
{
    // 从Trailers中取出堆栈信息
    var exceptionDetails = ex.Trailers.FirstOrDefault(t => t.Key == "ExceptionDetails")?.Value;
    if (!string.IsNullOrEmpty(exceptionDetails))
    {
        // 处理或打印堆栈信息
        Console.WriteLine(exceptionDetails);
    }
}

3. 结构化序列化异常信息（进阶） #

如果需要更规范的异常数据格式，可以将异常序列化为JSON字符串，存入Status.Detail字段：

服务端处理 #

using System.Text.Json;

catch (Exception ex)
{
    // 封装异常信息为结构化对象
    var errorInfo = new
    {
        Message = ex.Message,
        StackTrace = ex.StackTrace,
        InnerException = ex.InnerException?.ToString()
    };
    var errorJson = JsonSerializer.Serialize(errorInfo);
    
    throw new RpcException(new Status(StatusCode.Internal, errorJson));
}

客户端反序列化 #

using System.Text.Json;

catch (RpcException ex)
{
    if (!string.IsNullOrEmpty(ex.Status.Detail))
    {
        var errorInfo = JsonSerializer.Deserialize<dynamic>(ex.Status.Detail);
        Console.WriteLine($"错误信息：{errorInfo.Message}");
        Console.WriteLine($"堆栈跟踪：{errorInfo.StackTrace}");
    }
}

4. 生产环境安全建议 #

• 禁止在生产环境直接向外部暴露完整堆栈信息，仅在开发/测试环境开启详细错误。
• 生产环境将异常堆栈写入日志系统（如Serilog、NLog），通过日志排查问题，对外返回通用错误提示。

内容的提问来源于stack exchange，提问作者Sanjay Soni