避免 YAML 格式问题

编辑

配置文件使用 YAML 作为其语法。当您编辑文件以修改配置设置时,有一些事项需要注意。

使用空格进行缩进

编辑

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

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

查看默认配置文件以了解结构

编辑

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

测试您的配置文件

编辑

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

metricbeat test config -c metricbeat.yml

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

将正则表达式括在单引号中

编辑

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

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

将路径括在单引号中

编辑

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

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

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

编辑

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

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

避免意外的模板变量解析

编辑

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

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