WARNING: Version 5.3 of Winlogbeat has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Configuring Winlogbeat to Use Ingest Node YAML Tips and Gotchas »
Elastic Docs ›Winlogbeat Reference [5.3] ›Configuring Winlogbeat

Using Environment Variables in the Configuration

edit

Using Environment Variables in the Configuration

edit

You can use environment variable references in the winlogbeat.yml file to set values that need to be configurable during deployment. To do this, use:

${VAR}

Where VAR is the name of the environment variable.

Each variable reference is replaced at startup by the value of the environment variable. The replacement is case-sensitive and occurs before the YAML file is parsed. References to undefined variables are replaced by empty strings unless you specify a default value. To specify a default value, use:

${VAR:default_value}

Where default_value is the value to use if the environment variable is undefined.

If you need to use a literal ${ in your configuration file then you can write $${ to escape the expansion.

After changing the value of an environment variable, you need to restart Winlogbeat to pick up the new value.

Examples

edit

Here are some examples of configurations that use environment variables and what each configuration looks like after replacement:

Config source Environment setting Config after replacement

name: ${NAME}

export NAME=elastic

name: elastic

name: ${NAME}

no setting

name:

name: ${NAME:beats}

no setting

name: beats

name: ${NAME:beats}

export NAME=elastic

name: elastic
« Configuring Winlogbeat to Use Ingest Node YAML Tips and Gotchas »