避免 YAML 格式问题

配置文件使用 YAML 语法。编辑文件修改配置设置时，需要注意以下几点。

YAML 中缩进非常重要。确保使用空格而不是制表符进行缩进。

在默认配置文件和文档中的所有示例中，我们每个缩进级别使用 2 个空格。我们建议您也这样做。

了解在哪里定义配置选项的最佳方法是查看提供的示例配置文件。配置文件包含 Beat 可用的绝大多数默认配置。要更改设置，只需取消注释该行并更改值。

您可以测试配置文件以验证其结构是否有效。只需切换到安装二进制文件的目录，并使用指定的 test config 命令在前台运行 Beat。例如

winlogbeat test config -c winlogbeat.yml

如果 Beat 在文件中发现错误，您将看到一条消息。

如果需要在 YAML 文件中指定正则表达式，最好将正则表达式用单引号括起来，以解决 YAML 对字符串转义的复杂规则。

有关 YAML 的更多信息，请参见 http://yaml.org/。

特别是 Windows 路径有时包含空格或字符，例如驱动器号或三个点，YAML 解析器可能会误解这些字符。

为避免此问题，最好将路径用单引号括起来。

如果在数值字段中使用前导零（例如 09），而不将值用单引号括起来，YAML 解析器可能会错误地解释该值。如果该值是有效的八进制数，则将其转换为整数。如果不是，则将其转换为浮点数。

为防止意外的类型转换，请避免在字段值中使用前导零，或者将值用单引号括起来。

允许配置解析环境变量数据的模板引擎可能导致包含 $ 字符的字符串出现错误。例如，如果密码字段包含 $$，引擎会将其解析为 $。

要解决此问题，请使用 密钥库 或使用 $$ 转义所有 $ 实例。