首页
/ 在YARP反向代理中实现响应体大小日志记录的技术方案

在YARP反向代理中实现响应体大小日志记录的技术方案

2025-05-26 04:13:37作者:胡易黎Nicole

背景与需求分析

在现代微服务架构中,反向代理作为流量入口承担着关键作用。YARP(Yet Another Reverse Proxy)作为微软开源的灵活反向代理解决方案,开发者经常需要扩展其功能以满足特定业务需求。一个常见的需求是记录完整的请求/响应日志,特别是响应体大小这一关键指标。

技术挑战

传统基于Content-Length头部的方案存在明显局限性:

  1. 当服务端采用分块传输编码(Transfer-Encoding: chunked)时,响应头中不会包含Content-Length
  2. 直接读取响应流会带来性能问题,特别是在高并发场景下
  3. 需要确保日志记录不影响正常的请求处理流程

核心解决方案

流装饰器模式

通过创建自定义的Stream实现类来包装原始响应流,在数据写入时进行字节计数:

public class CountingStreamDecorator : Stream
{
    private readonly Stream _innerStream;
    public long BytesWritten { get; private set; }

    public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, 
        CancellationToken cancellationToken = default)
    {
        BytesWritten += buffer.Length;
        return _innerStream.WriteAsync(buffer, cancellationToken);
    }
    
    // 其他必要方法实现...
}

中间件实现要点

  1. 执行顺序:必须确保中间件在YARP之前执行
  2. 流管理:正确处理流生命周期
  3. 性能优化:使用ValueTask减少异步开销
public async Task Invoke(HttpContext context)
{
    var originalStream = context.Response.Body;
    using var countingStream = new CountingStreamDecorator(originalStream);
    
    context.Response.Body = countingStream;
    await _next(context);
    
    // 记录日志
    LogResponseSize(countingStream.BytesWritten);
    
    // 恢复原始流
    context.Response.Body = originalStream;
}

关键技术细节

  1. 数据完整性保证:当中间件的next调用完成时,所有响应数据都已写入计数流
  2. 分块传输处理:字节计数反映的是实际应用数据,不包含分块编码的开销
  3. 资源管理:只释放自定义装饰器,原始流由框架管理

性能优化建议

  1. 优先实现ValueTask版本的方法
  2. 避免不必要的await操作
  3. 考虑使用内存池技术减少分配
  4. 对于高频场景,可使用结构体替代类

扩展思考

该方案不仅适用于日志记录,还可应用于:

  • 流量监控
  • 请求限流
  • 数据校验等场景

通过这种非侵入式的流装饰器模式,开发者可以在不修改核心代理逻辑的情况下,灵活扩展YARP的功能,同时保持系统的高性能和稳定性。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
205
2.18 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
62
95
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
86
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133