避免 YAML 格式问题

配置文件使用 YAML 作为其语法。当你编辑文件以修改配置设置时，有一些你应该了解的事项。

缩进在 YAML 中是有意义的。请确保使用空格而不是制表符来缩进各个部分。

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

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

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

heartbeat test config -c heartbeat.yml

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

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

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

特别是 Windows 路径有时会包含空格或字符，例如驱动器盘符或三个点，YAML 解析器可能会错误地解释它们。

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

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

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

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

为了解决这个问题，可以使用 密钥存储，或者使用 $$ 转义所有 $ 实例。