Logstash Ruby解析日志报Invalid escape character syntax错误如何解决

问题根源 #

Ruby解析双引号包裹的字符串字面量时，会把反斜杠\识别为转义字符，你的日志里的\C、\E这类序列不属于Ruby支持的有效转义序列，所以在代码语法解析阶段就会直接抛出错误，还没到执行字符串处理逻辑的步骤。

解决方案 #

1. 测试时使用原始字符串写法避免转义 #

如果你是在本地测试，把日志内容硬编码到Ruby代码里验证逻辑，可以用下面两种写法保留原始的反斜杠：

• 用单引号包裹字符串：单引号里只有\'和\\会被转义，其他反斜杠都会原样保留

# 正确写法
test = 'LogicalDisk\C:\% Free Space=40.04815, LogicalDisk\C:\Free Megabytes=32606, LogicalDisk\E:\% Free Space=91.81561, LogicalDisk\E:\Free Megabytes=18802, LogicalDisk\F:\% Free Space=n/a, LogicalDisk\F:\Free Megabytes=n/a, LogicalDisk\HarddiskVolume1'

• 用%q{}原始字符串标记：完全不需要考虑转义问题，内容会原样读取

test = %q{LogicalDisk\C:\% Free Space=40.04815, LogicalDisk\C:\Free Megabytes=32606, LogicalDisk\E:\% Free Space=91.81561, LogicalDisk\E:\Free Megabytes=18802, LogicalDisk\F:\% Free Space=n/a, LogicalDisk\F:\Free Megabytes=n/a, LogicalDisk\HarddiskVolume1}

2. 实际生产环境从Logstash读取时的注意点 #

如果你的代码是直接从Logstash的输入、数据库或者外部文件读取日志内容，不会出现这个转义错误，这个错误只会发生在你把日志内容作为字符串字面量硬编码到Ruby代码里的场景。你只需要保证代码里不要直接把日志内容写在双引号里即可，外部输入的字符串会自动保留原始的反斜杠，后续你可以正常用gsub等方法处理内容。

3. 特殊场景下的双引号写法适配 #

如果因为特殊场景你必须保留双引号的写法，需要把所有的反斜杠都替换成双反斜杠\\，让Ruby识别为普通的反斜杠字符：

test = "LogicalDisk\\C:\\% Free Space=40.04815, LogicalDisk\\C:\\Free Megabytes=32606, LogicalDisk\\E:\\% Free Space=91.81561, LogicalDisk\\E:\\Free Megabytes=18802, LogicalDisk\\F:\\% Free Space=n/a, LogicalDisk\\F:\\Free Megabytes=n/a, LogicalDisk\\HarddiskVolume1"

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