YAML 提示和注意事项

配置文件使用 YAML 语法。当你编辑文件修改配置设置时，有一些需要注意的地方。

使用空格缩进编辑

YAML 中缩进是有意义的。确保你使用空格而不是制表符缩进。

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

查看默认配置文件的结构编辑

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

测试你的配置文件编辑

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

beatname test config -c beatname.yml

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

用单引号将正则表达式括起来编辑

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

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

用单引号将路径括起来编辑

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

为了避免此问题，最好将路径括在单引号中。

避免在数字值中使用前导零编辑

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

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

避免意外的模板变量解析编辑

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

为了解决这个问题，要么使用 密钥库，要么用 $$ 转义所有 $ 实例。