› ›

环境变量

您可以在配置文件中使用环境变量引用，以设置需要在部署期间进行配置的值。为此，请使用

${VAR}

其中 VAR 是环境变量的名称。

每个变量引用在启动时都会被环境变量的值替换。替换是区分大小写的，并且发生在 YAML 文件解析之前。除非您指定默认值或自定义错误文本，否则对未定义变量的引用将被替换为空字符串。

要指定默认值，请使用

${VAR:default_value}

其中 default_value 是在环境变量未定义时使用的值。

要指定自定义错误文本，请使用

${VAR:?error_text}

其中 error_text 是自定义文本，如果无法展开环境变量，则会将其添加到错误消息的前面。

如果需要在配置文件中使用特殊字符，请使用 $ 来转义扩展。例如，您可以使用 $${ 或 $} 来转义 ${ 或 }。

更改环境变量的值后，您需要重新启动 Beat 才能获取新值。

当您使用 -E 选项从命令行覆盖配置设置时，也可以指定环境变量。例如

-E name=${NAME}

以下是一些使用环境变量的配置示例，以及替换后每个配置的样子

配置来源	环境变量设置	替换后的配置
`name: ${NAME}`	`export NAME=elastic`	`name: elastic`
`name: ${NAME}`	无设置	`name`
`name: ${NAME:beats}`	无设置	`name: beats`
`name: ${NAME:beats}`	`export NAME=elastic`	`name: elastic`
`name: ${NAME:?You need to set the NAME environment variable}`	无设置	无。返回一个错误消息，该消息前面附加了自定义文本。
`name: ${NAME:?You need to set the NAME environment variable}`	`export NAME=elastic`	`name: elastic`

您可以使用类似 JSON 的语法在环境变量中指定复杂对象，例如列表或字典。

与 JSON 一样，字典和列表使用 {} 和 [] 构造。但与 JSON 不同，此语法允许尾随逗号和稍微不同的字符串引用规则。字符串可以不加引号、使用单引号或双引号，这方便了简单设置，并使您更容易在 shell 中混合使用引号。顶级的数组不需要括号 ([])。

例如，以下环境变量设置为列表

ES_HOSTS="10.45.3.2:9220,10.45.3.1:9230"

您可以在配置文件中引用此变量

output.elasticsearch:
  hosts: '${ES_HOSTS}'

当 Beat 加载配置文件时，它会在读取 hosts 设置之前解析环境变量并将其替换为指定的列表。

不要使用双引号 (") 包裹正则表达式，否则反斜杠 (\) 将被解释为转义字符。