Envoy Gateway中访问日志格式PATH字段使用注意事项

在Envoy Gateway项目中，配置访问日志格式时需要注意PATH字段的使用方式。本文将详细介绍相关技术细节和最佳实践。

访问日志格式配置问题

Envoy Gateway允许用户自定义访问日志的格式，但在使用过程中发现当配置中包含%PATH%字段时，Envoy代理会拒绝配置更新并报错："Not supported field in StreamInfo: PATH"。

解决方案

正确的做法是使用%REQ(:path)%替代%PATH%。这两种写法虽然目的相同，但在Envoy中的实现方式不同：

1. %PATH%是Envoy 1.34.0版本引入的新命令操作符
2. %REQ(:path)%是更传统且广泛支持的写法，用于获取HTTP请求的路径部分

技术背景

Envoy的访问日志支持多种命令操作符，用于提取不同的请求和响应信息。这些操作符分为几类：

1. 请求头操作符：以REQ开头，如REQ(:path)
2. 响应头操作符：以RESP开头
3. 动态元数据操作符：以DYNAMIC_METADATA开头
4. 过滤器状态操作符：以FILTER_STATE开头

最佳实践建议

1. 检查Envoy版本：如果使用较新版本(1.34.0+)可以考虑使用%PATH%，但为了兼容性推荐使用%REQ(:path)%
2. 完整测试：修改访问日志格式后应进行全面测试
3. 参考官方文档：了解所有支持的命令操作符及其用法

总结

在Envoy Gateway中配置访问日志时，路径信息的获取应优先使用%REQ(:path)%而非%PATH%，这能确保更好的兼容性和稳定性。随着Envoy版本的更新，新的命令操作符会不断加入，但生产环境中建议使用经过充分验证的写法。