WARNING: Version 6.2 of Metricbeat 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.
When you configure Metricbeat, you might need to specify sensitive settings, such as passwords. Rather than relying on file system permissions to protect these values, you can use the Metricbeat keystore to securely store secret values for use in configuration settings.
After adding a key and its secret value to the keystore, you can use the key in place of the secret value when you configure sensitive settings.
The syntax for referencing keys is identical to the syntax for environment variables:
Where KEY is the name of the key.
For example, imagine that the keystore contains a key called
ES_PWD with the
In the configuration file, use
On the command line, use:
When Metricbeat unpacks the configuration, it resolves keys before resolving environment variables and other variables.
Notice that the Metricbeat keystore differs from the Elasticsearch keystore.
Whereas the Elasticsearch keystore lets you store
elasticsearch.yml values by
name, the Metricbeat keystore lets you specify arbitrary names that you can
reference in the Metricbeat configuration.
To create and manage keys, use the
keystore command. See the
command reference for the full command syntax, including
keystore command must be run by the same user who will run
Create a keystoreedit
To create a secrets keystore, use:
metricbeat keystore create
Metricbeat creates the keystore in the directory defined by the
To store sensitive values, such as authentication credentials for Elasticsearch,
keystore add command:
metricbeat keystore add ES_PWD
When prompted, enter a value for the key.
To overwrite an existing key’s value, use the
metricbeat keystore add ES_PWD --force
To pass the value through stdin, use the
--stdin flag. You can also use
cat /file/containing/setting/value | metricbeat keystore add ES_PWD --stdin --force
To list the keys defined in the keystore, use:
metricbeat keystore list
To remove a key from the keystore, use:
metricbeat keystore remove ES_PWD