YAML 使用技巧和注意事项

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

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

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

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

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

beatname test config -c beatname.yml

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

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

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

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

为了避免这个问题，最好将路径用单引号引起来。

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

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

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

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