避免 YAML 格式问题
编辑避免 YAML 格式问题编辑
配置文件使用 YAML 作为其语法。在编辑文件以修改配置设置时,您需要了解以下几点。
使用空格进行缩进编辑
缩进在 YAML 中具有含义。确保使用空格而不是制表符来缩进部分。
在默认配置文件和文档中的所有示例中,我们每个缩进级别使用 2 个空格。我们建议您也这样做。
查看默认配置文件以了解结构编辑
了解在哪里定义配置选项的最佳方法是查看提供的示例配置文件。配置文件包含 Beat 可用的绝大多数默认配置。要更改设置,只需取消注释该行并更改值即可。
测试您的配置文件编辑
您可以测试配置文件以验证其结构是否有效。只需切换到安装二进制文件的目录,然后使用指定的 test config
命令在前台运行 Beat。例如
auditbeat test config -c auditbeat.yml
如果 Beat 在文件中发现错误,您将看到一条消息。
将正则表达式括在单引号中编辑
如果需要在 YAML 文件中指定正则表达式,最好将正则表达式括在单引号中,以解决 YAML 关于字符串转义的棘手规则。
有关 YAML 的更多信息,请参阅 http://yaml.org/。
将路径括在单引号中编辑
特别是 Windows 路径,有时包含空格或字符(例如驱动器号或省略号),这些空格或字符可能会被 YAML 解析器错误解释。
为了避免此问题,最好将路径括在单引号中。
避免在数值中使用前导零编辑
如果在数值字段中使用前导零(例如,09
)而不将值括在单引号中,则 YAML 解析器可能会错误解释该值。如果该值是有效的八进制数,则将其转换为整数。否则,它将转换为浮点数。
为了防止不必要的类型转换,请避免在字段值中使用前导零,或者将值括在单引号中。
避免意外的模板变量解析编辑
允许配置从环境变量解析数据的模板引擎可能会导致包含 $
字符的字符串出错。例如,如果密码字段包含 $$
,则引擎会将其解析为 $
。
要解决此问题,可以使用 密钥库 或使用 $$
转义所有 $
实例。