Envoy代理中WASM过滤器属性日志编码问题解析

在Envoy代理的实际应用中，WASM过滤器因其灵活性和高性能而广受欢迎。然而，开发者在集成过程中可能会遇到一个常见问题：通过WASM过滤器设置的属性在访问日志中会以Base64编码的BytesValue协议缓冲区形式出现，而非预期的纯文本格式。

问题现象

当使用Rust SDK在WASM过滤器中设置属性时，例如设置组织单位(ou)、域名组件(dc)和账户名称等属性，这些属性值会被Envoy记录为Base64编码的协议缓冲区格式。这种编码方式虽然保证了数据的完整性，但对于日志分析和监控来说却增加了额外的解码步骤。

技术背景

Envoy代理在处理WASM过滤器属性时，其底层ABI(应用二进制接口)设计并不假设所有字符串都是UTF-8编码。这种设计决策源于网络环境中可能遇到的各种编码格式和非文本数据。因此，Envoy将所有的属性值都视为原始字节数组进行处理，这导致了在日志输出时的编码行为。

解决方案

Envoy提供了灵活的日志格式化选项来解决这一问题。通过在日志格式字符串中使用:PLAIN修饰符，可以强制Envoy将过滤器状态以原始字符串形式输出，而不进行协议缓冲区编码。例如：

"wasm_ou": "%FILTER_STATE(wasm.ou:PLAIN)%"

这种方法简单有效，特别适用于确认属性值为纯文本的场景。但开发者需要注意，如果属性值确实包含非文本数据，使用:PLAIN修饰符可能会导致日志输出异常。

最佳实践

1. 明确数据类型：在设置属性前，明确该属性是否确实为文本数据。对于非文本数据，保持默认的编码输出更为安全。

2. 日志格式验证：在部署前，验证日志输出是否符合预期，特别是当属性值包含特殊字符时。

3. 性能考量：虽然:PLAIN修饰符解决了可读性问题，但在高吞吐量系统中，额外的格式处理可能带来轻微性能开销。

4. 错误处理：考虑在WASM过滤器中添加对属性值的验证逻辑，确保它们符合预期的格式要求。

深入理解

Envoy的这种设计实际上反映了其作为通用代理的灵活性。通过将属性视为原始字节，Envoy能够处理各种类型的数据，而不仅限于文本。这种设计虽然在某些场景下增加了使用复杂度，但却为处理各种网络协议和数据格式提供了坚实的基础。

对于开发者而言，理解这一设计理念有助于更好地利用Envoy的强大功能。在需要纯文本输出的场景下，:PLAIN修饰符提供了一种简单直接的解决方案；而在处理复杂数据时，默认的编码方式则保证了数据的完整性和准确性。

通过合理运用这些特性，开发者可以在保证系统稳定性的同时，获得符合业务需求的日志输出格式。