在配置中使用环境变量

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

${VAR}

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

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

要指定默认值，请使用

${VAR:default_value}

其中 default_value 是如果环境变量未定义要使用的值。

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

${VAR:?error_text}

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

如果您需要在配置文件中使用字面量 ${，则可以使用 $${ 来转义展开。

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

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

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

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

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

ES_HOSTS="10.45.3.2:9220,10.45.3.1:9230"

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

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

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

要选择退出此复杂对象解析行为，以便始终将环境变量解析为字符串，请将环境变量用双引号 (") 括起来，并转义其中的所有双引号。

例如，给定以下配置

output.elasticsearch:
  password: '${ES_PASSWORD}'

如果目标密码是 foo,bar"baz，为了避免由于复杂对象解析导致的解析错误，应如下设置环境变量：

ES_PASSWORD='"foo,bar\"baz"'