3.1 KiB
| title | description | menu | weight | ||||
|---|---|---|---|---|---|---|---|
| telegraf secrets get | The `telegraf secrets get` command retrieves the value of a secret from the specified secret store. |
|
301 |
The telegraf secrets get command retrieves the value of a secret from the
specified secret store.
{{% note %}}
This command requires your configuration file that contains the secret store
definitions you want to access. If the --config or --config-directory flags
are not included in the command, Telegraf checks the
default configuration file location.
{{% /note %}}
Use telegraf secrets list to get the
IDs of available secret stores and the available secret keys.
If you haven't configured a secret store, use
telegraf plugins secretstores
to list available secret store plugins.
View secret store plugin configuration documentation in the
Telegraf GitHub repository.
Usage
telegraf [global-flags] secrets get [flags] <SECRET_STORE_ID> <SECRET_KEY>
Arguments
| Argument | Description |
|---|---|
| SECRET_STORE_ID | ID of the secret store to retrieve the secret from |
| SECRET_KEY | Key of the secret to retrieve |
Flags
| Flag | Description | |
|---|---|---|
-h |
--help |
Show command help |
{{% caption %}} Also see Telegraf global flags. {{% /caption %}}
Examples
- Retrieve a secret using the default configuration location
- Retrieve a secret using a non-default configuration location
In the examples below, replace the following:
- {{% code-placeholder-key %}}
SECRET_STORE_ID{{% /code-placeholder-key %}}: The ID of the secret store to retrieve the secret from. - {{% code-placeholder-key %}}
SECRET_KEY{{% /code-placeholder-key %}}: The key of the secret to retrieve from the secret store. - {{% code-placeholder-key %}}
CUSTOM_CONFIG_PATH{{% /code-placeholder-key %}}: The non-default filepath to your Telegraf configuration file containing your secret store definitions.
Retrieve a secret using the default configuration location
The following example assumes the Telegraf configuration file that contains the secret store definition is at the default location.
{{% code-placeholders "SECRET_(STORE_ID|KEY)" %}}
telegraf secrets get SECRET_STORE_ID SECRET_KEY
{{% /code-placeholders %}}
Retrieve a secret using a non-default configuration location
{{% code-placeholders "CUSTOM_CONFIG_PATH|SECRET_(STORE_ID|KEY)" %}}
telegraf --config CUSTOM_CONFIG_PATH secrets get SECRET_STORE_ID SECRET_KEY
{{% /code-placeholders %}}