在配置中使用环境变量

编辑

在配置中使用环境变量

编辑

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

${VAR}

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

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

要指定默认值,请使用

${VAR:default_value}

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

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

${VAR:?error_text}

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

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

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

当你使用 -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}'

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

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