在配置中使用环境变量

编辑

在配置中使用环境变量

编辑

您可以在配置文件中使用环境变量引用来设置在部署期间需要配置的值。要做到这一点,请使用

${VAR}

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

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

要指定默认值,请使用

${VAR:default_value}

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

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

${VAR:?error_text}

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

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

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

当您使用 -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:?您需要设置 NAME 环境变量}

无设置

无。返回以自定义文本作为前缀的错误消息。

name: ${NAME:?您需要设置 NAME 环境变量}

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}'

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

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