Telegraf v1.30.0 and v1.30.1 (#5407)

* add telegraf 1.30.0 release notes and supporting content, closes #5405

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* added telegraf 1.30.1

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
monitor-dedicated-cluster
Scott Anderson 2024-04-03 14:36:07 -06:00 committed by GitHub
parent fdd44fb268
commit 2aac3cc2e8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 1068 additions and 164 deletions

View File

@ -5,7 +5,7 @@ description: >
time series platform, used to collect and report metrics. Telegraf supports four categories of plugins -- input, output, aggregator, and processor.
menu:
telegraf_v1:
name: Telegraf v1.29
name: Telegraf v1.30
weight: 1
related:
- /resources/videos/intro-to-telegraf/

View File

@ -1,91 +0,0 @@
---
title: Telegraf commands and flags
description: The `telegraf` command starts and runs all the processes necessary for Telegraf to function.
menu:
telegraf_v1_ref:
name: Commands
weight: 25
---
The `telegraf` command starts and runs all the processes necessary for Telegraf to function.
## Usage
```
telegraf [commands]
telegraf [flags]
```
## Commands
| Command | Description |
| :-------- | :--------------------------------------------- |
| `config` | Print out full sample configuration to stdout. |
| `version` | Print version to stdout. |
## Flags {id="telegraf-command-flags"}
| Flag | Description |
| :------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| `--aggregator-filter <filter>` | Filter aggregators to enable. Separator is `:`. |
| `--config <file>` | Configuration file to load. |
| `--config-directory <directory>` | Directory containing additional `*.conf` files. |
| `--deprecation-list` | Print all deprecated plugins or plugin options. |
| `--watch-config` | Restart Telegraf on local configuration changes. Use either fs notifications (`inotify`) or polling (`poll`). Disabled by default |
| `--plugin-directory <directory>` | Directory containing `*.so` files to search recursively for plugins. Found plugins are loaded, tagged, and identified. |
| `--debug` | Enable debug logging. |
| `--input-filter <filter>` | Filter input plugins to enable. Separator is `:`. |
| `--input-list` | Print available input plugins. |
| `--output-filter` | Filter output plugins to enable. Separator is `:`. |
| `--output-list` | Print available output plugins. |
| `--pidfile <file>` | File to write PID to. |
| `--pprof-addr <address>` | pprof address to listen on. Disabled by default. |
| `--processor-filter <filter>` | Filter processor plugins to enable. Separator is `:`. |
| `--quiet` | Run in quiet mode. |
| `--section-filter <filter>` | Filter configuration sections to output (`agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`). Separator is `:`. |
| `--sample-config` | Print full sample configuration. |
| `--once` | Gather metrics once, write them, and exit. |
| `--test` | Gather metrics once and print them. |
| `--test-wait` | Number of seconds to wait for service inputs to complete in test or once mode. |
| `--usage <plugin>` | Print plugin usage (example: `telegraf --usage mysql`). |
| `--version` | Print Telegraf version. |
## Examples
### Generate a Telegraf configuration file
```sh
telegraf config > telegraf.conf
```
### Generate configuration with only CPU input and InfluxDB output plugins defined
```sh
telegraf --input-filter cpu --output-filter influxdb config
```
### Run a single Telegraf configuration, outputting metrics to stdout
```sh
telegraf --config telegraf.conf --test
```
### Run Telegraf with all plugins defined in configuration file**
```sh
telegraf --config telegraf.conf
```
### Run Telegraf, enabling the CPU and memory input plugins and InfluxDB output plugin**
```sh
telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
```
### Run Telegraf with pprof
```sh
telegraf --config telegraf.conf --pprof-addr localhost:6060
```

View File

@ -0,0 +1,110 @@
---
title: Telegraf commands and flags
description: The `telegraf` command starts and runs all the processes necessary for Telegraf to function.
menu:
telegraf_v1_ref:
name: Telegraf commands
weight: 25
---
The `telegraf` command starts and runs all the processes necessary for Telegraf to function.
## Usage
```
telegraf [commands]
telegraf [flags]
```
## Commands
| Command | Description |
| :---------------------------------------- | :------------------------------------------- |
| [config](/telegraf/v1/commands/config/) | Generate and migrate Telegraf configurations |
| [secrets](/telegraf/v1/commands/secrets/) | Manage secrets in secret stores |
| [plugins](/telegraf/v1/commands/plugins/) | Print available plugins |
| [version](/telegraf/v1/commands/version/) | Print current version to stdout |
## Global flags {id="telegraf-global-flags"}
| Flag | Description |
| :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--config <file>` | Configuration file to load. |
| `--config-directory <directory>` | Directory containing additional `*.conf` files. |
| `--test-wait` | Number of seconds to wait for service inputs to complete in test or once mode. |
| `--usage <plugin>` | Print plugin usage (example: `telegraf --usage mysql`). |
| `--pprof-addr <address>` | pprof address to listen on. Disabled by default. |
| `--watch-config` | Restart Telegraf on local configuration changes. Use either fs notifications (`notify`) or polling (`poll`). Disabled by default. |
| `--pidfile <file>` | File to write PID to. |
| `--password <password>` | Password to unlock secret stores. |
| `--old-env-behavior` | Switch back to pre-v1.27 environment replacement behavior. |
| `--once` | Gather metrics once, write them, and exit. |
| `--debug` | Enable debug logging. |
| `--quiet` | Run in quiet mode. |
| `--unprotected` | Do not protect secrets in memory. |
| `--test` | Gather metrics once and print them. |
| `--deprecation-list` | Print all deprecated plugins or plugin options. |
| `--input-list` | Print available input plugins. |
| `--output-list` | Print available output plugins. |
| `--version` | ({{< req "Deprecated" >}}) Print Telegraf version. |
| `--sample-config` | ({{< req "Deprecated" >}}) Print full sample configuration. |
| `--plugin-directory <directory>` | ({{< req "Deprecated" >}}) Directory containing `*.so` files to search recursively for plugins. Found plugins are loaded, tagged, and identified. |
| `--section-filter <filter>` | Filter configuration sections to output (`agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`). Separator is `:`. |
| `--input-filter <filter>` | Filter input plugins to enable. Separator is `:`. |
| `--output-filter` | Filter output plugins to enable. Separator is `:`. |
| `--aggregator-filter <filter>` | Filter aggregators to enable. Separator is `:`. |
| `--processor-filter <filter>` | Filter processor plugins to enable. Separator is `:`. |
| `--secretstore-filter <filter>` | Filter secretstore plugins to enable. Separator is `:`. |
## Examples
- [Generate a Telegraf configuration file](#generate-a-telegraf-configuration-file)
- [Generate a configuration with only specific plugins](#generate-a-configuration-with-only-specific-plugins)
- [Run a single Telegraf configuration and output metrics to stdout](#run-a-single-telegraf-configuration-and-output-metrics-to-stdout)
- [Run Telegraf with all plugins defined in configuration file](#run-telegraf-with-all-plugins-defined-in-configuration-file)
- [Run Telegraf, but only enable specific plugins](#run-telegraf-but-only-enable-specific-plugins)
- [Run Telegraf with pprof](#run-telegraf-with-pprof)
### Generate a Telegraf configuration file
```sh
telegraf config > telegraf.conf
```
### Generate a configuration with only specific plugins
```sh
telegraf config \
--input-filter cpu \
--output-filter influxdb
```
### Run a single Telegraf configuration and output metrics to stdout
```sh
telegraf --config telegraf.conf --test
```
### Run Telegraf with all plugins defined in configuration file
```sh
telegraf --config telegraf.conf
```
### Run Telegraf, but only enable specific plugins
```sh
telegraf \
--config telegraf.conf \
--input-filter cpu:mem \
--output-filter influxdb
```
### Run Telegraf with pprof
```sh
telegraf \
--config telegraf.conf \
--pprof-addr localhost:6060
```

View File

@ -0,0 +1,71 @@
---
title: telegraf config
description: >
The `telegraf config` command generates Telegraf configuration files and migrates deprecated plugins in configuration files.
menu:
telegraf_v1_ref:
parent: Telegraf commands
weight: 201
---
The `telegraf config` command generates Telegraf configuration files and migrates deprecated plugins in configuration files.
## Usage
```sh
telegraf [global-flags] config [subcommand] [flags]
```
## Subcommands
| Subcommand | Description |
| :----------------------------------------------------------------------------- | :---------------------------------------------- |
| [create](/telegraf/v1/commands/config/create/) <em class="op50">(default)</em> | Create and output a Telegraf configuration |
| [migrate](/telegraf/v1/commands/config/migrate/) | Migrate deprecated plugins to supported plugins |
| help, h | Show command help |
## Flags
| Flag | | Description |
| :--- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
| | `--section-filter` | Filter sections to print separated by `:` (Valid values are `agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`) |
| | `--input-filter` | Filter inputs to enable separated by `:` |
| | `--output-filter` | Filter outputs to enable separated by `:` |
| | `--aggregator-filter` | Filter aggregators to enable separated by `:` |
| | `--processor-filter` | Filter processors to enable separated by `:` |
| | `--secretstore-filter` | Filter secret-stores to enable separated by `:` |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
- [Create a full configuration](#create-a-full-configuration)
- [Create a full configuration as save it to a file](#create-a-full-configuration-as-save-it-to-a-file)
- [Create a configuration with specific sections and plugins](#create-a-configuration-with-specific-sections-and-plugins)
### Create a full configuration
```sh
telegraf config
```
### Create a full configuration as save it to a file
```sh
telegraf config > telegraf.conf
```
### Create a configuration with specific sections and plugins
To print a configuration containing only a Modbus input plugin and an
InfluxDB v2 output plugin, run the following:
```sh
telegraf config \
--section-filter "inputs:outputs" \
--input-filter "modbus" \
--output-filter "influxdb_v2"
```

View File

@ -0,0 +1,67 @@
---
title: telegraf config create
description: >
The `telegraf config create` command returns a full Telegraf configuration
containing all plugins as an example. You can also apply section or plugin
filters to reduce the output to the plugins you need.
menu:
telegraf_v1_ref:
parent: telegraf config
weight: 301
---
The `telegraf config create` command returns a full Telegraf configuration
containing all plugins as an example. You can also apply section or plugin
filters to reduce the output to the plugins you need.
## Usage
```sh
telegraf [global-flags] config create [flags]
```
## Flags
| Flag | | Description |
| :--- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
| | `--section-filter` | Filter sections to print separated by `:` (Valid values are `agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`) |
| | `--input-filter` | Filter inputs to enable separated by `:` |
| | `--output-filter` | Filter outputs to enable separated by `:` |
| | `--aggregator-filter` | Filter aggregators to enable separated by `:` |
| | `--processor-filter` | Filter processors to enable separated by `:` |
| | `--secretstore-filter` | Filter secret-stores to enable separated by `:` |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
- [Create a full configuration](#create-a-full-configuration)
- [Create a full configuration as save it to a file](#create-a-full-configuration-as-save-it-to-a-file)
- [Create a configuration with specific sections and plugins](#create-a-configuration-with-specific-sections-and-plugins)
### Create a full configuration
```sh
telegraf config create
```
### Create a full configuration as save it to a file
```sh
telegraf config create > telegraf.conf
```
### Create a configuration with specific sections and plugins
To print a configuration containing only a Modbus input plugin and an
InfluxDB v2 output plugin, run the following:
```sh
telegraf config create \
--section-filter "inputs:outputs" \
--input-filter "modbus" \
--output-filter "influxdb_v2"
```

View File

@ -0,0 +1,66 @@
---
title: telegraf config migrate
description: >
The `telegraf config migrate` migrates deprecated plugins in a Telegraf configuration file to supported plugins.
menu:
telegraf_v1_ref:
parent: telegraf config
weight: 301
---
The `telegraf config migrate` command reads the configuration files specified
in the `--config` or `--config-directory` and attempts to migrate plugins or
options that are currently deprecated to the recommended replacements.
If no configuration file is explicitly specified, the command reads the
[default locations](/telegraf/v1/configuration/#configuration-file-locations)
and uses those configuration files.
Migrated files are stored with a `.migrated` suffix at the
location of the source configuration files.
If migrating remote configurations, the migrated configuration is stored in the
current directory using the URL as the filename with a `.migrated` suffix.
{{% warn %}}
#### Test migrated configuration files
We strongly recommend testing migrated configuration files before using them in production.
{{% /warn %}}
## Usage
```sh
telegraf [global-flags] config migrate [flags]
```
## Flags
| Flag | | Description |
| :--- | :-------- | :----------------------------------------------- |
| | `--force` | Forces overwriting of an existing migration file |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
- [Migrate a single configuration file](#migrate-a-single-configuration-file)
- [Migrate a configuration directory](#migrate-a-configuration-directory)
### Migrate a single configuration file
To migrate the file `mysettings.conf`, run the following command:
```sh
telegraf --config mysettings.conf config migrate
```
### Migrate a configuration directory
To migrate all configurations files in the `~/telegraf/conf/` directory, use
the following command:
```sh
telegraf --config-directory ~/telegraf/conf/ config migrate
```

View File

@ -0,0 +1,42 @@
---
title: telegraf plugins
description: >
The `telegraf plugins` command prints available Telegraf plugins.
menu:
telegraf_v1_ref:
parent: Telegraf commands
weight: 201
---
The `telegraf plugins` command prints available Telegraf plugins.
## Usage
```sh
telegraf [global-flags] plugins [subcommand] [flags]
```
## Subcommands
| Subcommand | Description |
| :---------------------------------------------------------- | :---------------------------------- |
| [inputs](/telegraf/v1/commands/plugins/inputs/) | Print available input plugins |
| [outputs](/telegraf/v1/commands/plugins/outputs/) | Print available output plugins |
| [processors](/telegraf/v1/commands/plugins/processors/) | Print available processor plugins |
| [aggregators](/telegraf/v1/commands/plugins/aggregators/) | Print available aggregator plugins |
| [secretstores](/telegraf/v1/commands/plugins/secretstores/) | Print available secretstore plugins |
| help, h | Shows command help |
## Flags
| Flag | | Description |
| :--- | :------------- | :---------------------------- |
| | `--deprecated` | Print only deprecated plugins |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples

View File

@ -0,0 +1,36 @@
---
title: telegraf plugins aggregators
description: >
The `telegraf plugins aggregators` command prints available aggregator plugins.
menu:
telegraf_v1_ref:
parent: telegraf plugins
weight: 304
---
The `telegraf plugins aggregators` command prints available aggregator plugins.
## Usage
```sh
telegraf [global-flags] plugins aggregators [flags]
```
## Flags
| Flag | | Description |
| :--- | :------------- | :---------------------------- |
| | `--deprecated` | Print only deprecated plugins |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
### List available aggregator plugins
```sh
telegraf plugins aggregators
```

View File

@ -0,0 +1,42 @@
---
title: telegraf plugins inputs
description: >
The `telegraf plugins inputs` command prints available input plugins.
menu:
telegraf_v1_ref:
parent: telegraf plugins
weight: 301
---
The `telegraf plugins inputs` command prints available input plugins.
## Usage
```sh
telegraf [global-flags] plugins inputs [flags]
```
## Flags
| Flag | | Description |
| :--- | :------------- | :---------------------------- |
| | `--deprecated` | Print only deprecated plugins |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
### List available input plugins
```sh
telegraf plugins inputs
```
### List deprecated input plugins
```sh
telegraf plugins inputs --deprecated
```

View File

@ -0,0 +1,42 @@
---
title: telegraf plugins outputs
description: >
The `telegraf plugins outputs` command prints available output plugins.
menu:
telegraf_v1_ref:
parent: telegraf plugins
weight: 302
---
The `telegraf plugins outputs` command prints available output plugins.
## Usage
```sh
telegraf [global-flags] plugins outputs [flags]
```
## Flags
| Flag | | Description |
| :--- | :------------- | :---------------------------- |
| | `--deprecated` | Print only deprecated plugins |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
### List available output plugins
```sh
telegraf plugins outputs
```
### List deprecated output plugins
```sh
telegraf plugins outputs --deprecated
```

View File

@ -0,0 +1,36 @@
---
title: telegraf plugins processors
description: >
The `telegraf plugins processors` command prints available processor plugins.
menu:
telegraf_v1_ref:
parent: telegraf plugins
weight: 303
---
The `telegraf plugins processors` command prints available processor plugins.
## Usage
```sh
telegraf [global-flags] plugins processors [flags]
```
## Flags
| Flag | | Description |
| :--- | :------------- | :---------------------------- |
| | `--deprecated` | Print only deprecated plugins |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
### List available processor plugins
```sh
telegraf plugins processors
```

View File

@ -0,0 +1,36 @@
---
title: telegraf plugins secretstores
description: >
The `telegraf plugins secretstores` command prints available secretstore plugins.
menu:
telegraf_v1_ref:
parent: telegraf plugins
weight: 305
---
The `telegraf plugins secretstores` command prints available secretstore plugins.
## Usage
```sh
telegraf [global-flags] plugins secretstores [flags]
```
## Flags
| Flag | | Description |
| :--- | :------------- | :---------------------------- |
| | `--deprecated` | Print only deprecated plugins |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
### List available secretstore plugins
```sh
telegraf plugins secretstores
```

View File

@ -0,0 +1,36 @@
---
title: telegraf secrets
description: >
The `telegraf secrets` command manages secrets in secret stores to use with Telegraf.
menu:
telegraf_v1_ref:
parent: Telegraf commands
weight: 201
---
The `telegraf secrets` command manages secrets in secret stores to use with Telegraf.
## Usage
```sh
telegraf [global-flags] secrets [subcommand] [flags]
```
## Subcommands
| Subcommand | Description |
| :------------------------------------------ | :------------------------------------------------- |
| [list](/telegraf/v1/commands/secrets/list/) | List known secrets and secret stores |
| [get](/telegraf/v1/commands/secrets/get/) | Retrieve the value of a secret from a secret store |
| [set](/telegraf/v1/commands/secrets/set/) | Create or modify a secret in a secret store |
| `help`, `h` | Shows command help |
## Flags
| Flag | | Description |
| :--- | :------- | :---------------- |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}

View File

@ -0,0 +1,86 @@
---
title: telegraf secrets get
description: >
The `telegraf secrets get` command retrieves the value of a secret from the
specified secret store.
menu:
telegraf_v1_ref:
parent: telegraf secrets
weight: 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](/telegraf/v1/configuration/#configuration-file-locations).
{{% /note %}}
Use [`telegraf secrets list`](/telegraf/v1/commands/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`](/telegraf/v1/commands/plugins/secretstores/)
to list available secret store plugins.
View secret store plugin configuration documentation in the
[Telegraf GitHub repository](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores).
## Usage
```sh
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](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
- [Retrieve a secret using the default configuration location](#retrieve-a-secret-using-the-default-configuration-location)
- [Retrieve a secret using a non-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](/telegraf/v1/configuration/#configuration-file-locations).
{{% code-placeholders "SECRET_(STORE_ID|KEY)" %}}
```sh
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)" %}}
```sh
telegraf --config CUSTOM_CONFIG_PATH secrets get SECRET_STORE_ID SECRET_KEY
```
{{% /code-placeholders %}}

View File

@ -0,0 +1,96 @@
---
title: telegraf secrets list
description: >
The `telegraf secrets list` command lists known secrets and secret stores.
menu:
telegraf_v1_ref:
parent: telegraf secrets
weight: 301
---
The `telegraf secrets list` command lists known secrets and secret stores.
{{% 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](/telegraf/v1/configuration/#configuration-file-locations).
{{% /note %}}
If you haven't configured a secret store, use
[`telegraf plugins secretstores`](/telegraf/v1/commands/plugins/secretstores/)
to list available secret store plugins.
View secret store plugin configuration documentation in the
[Telegraf GitHub repository](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores).
## Usage
```sh
telegraf [global-flags] secrets list [flags] [SECRET_STORE_ID[ ...[SECRET_STORE_ID]]]
```
## Arguments
| Argument | Description |
| :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **SECRET_STORE_ID** | ID of the secret store to list secrets from. You can include multiple, space-delimited IDs. If no ID(s) are provided, the command lists secrets from all secret stores. |
## Flags
| Flag | | Description |
| :--- | :---------------- | :------------------ |
| | `--reveal-secret` | Print secret values |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
- [List secrets and secret stores using the default configuration location](#list-secrets-and-secret-stores-using-the-default-configuration-location)
- [List secrets and secret stores using a non-default configuration location](#list-secrets-and-secret-stores-using-a-non-default-configuration-location)
- [List secrets from a specific secret store](#list-secrets-from-a-specific-secret-store)
- [Show secret values when listing secrets and secret stores](#show-secret-values-when-listing-secrets-and-secret-stores)
### List secrets and secret stores using the default configuration location
The following example assumes the Telegraf configuration file that contains the
secret store definition is at the [default location](/telegraf/v1/configuration/#configuration-file-locations).
```sh
telegraf secrets list
```
### List secrets and secret stores using a non-default configuration location
{{% code-placeholders "CUSTOM_CONFIG_PATH" %}}
```sh
telegraf --config CUSTOM_CONFIG_PATH secrets list
```
{{% /code-placeholders %}}
- Replace {{% code-placeholder-key %}}`CUSTOM_CONFIG_PATH`{{% /code-placeholder-key %}}
with the non-default filepath to your Telegraf configuration file containing
your secret store definitions.
### List secrets from a specific secret store
{{% code-placeholders "SECRET_STORE_ID" %}}
```sh
telegraf secrets list SECRET_STORE_ID
```
{{% /code-placeholders %}}
- Replace {{% code-placeholder-key %}}`SECRET_STORE_ID`{{% /code-placeholder-key %}}
with the ID of the secret store to retrieve the secret from.
### Show secret values when listing secrets and secret stores
To print secret values with listing secrets and secret stores, include the
`--reveal-secret` flag:
```sh
telegraf secrets list --reveal-secret
```

View File

@ -0,0 +1,93 @@
---
title: telegraf secrets set
description: >
The `telegraf secrets set` command creates or modify a secret in a specified
secret store.
menu:
telegraf_v1_ref:
parent: telegraf secrets
weight: 301
---
The `telegraf secrets set` command creates or modify a secret in a 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](/telegraf/v1/configuration/#configuration-file-locations).
{{% /note %}}
Use [`telegraf secrets list`](/telegraf/v1/commands/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`](/telegraf/v1/commands/plugins/secretstores/)
to list available secret store plugins.
View secret store plugin configuration documentation in the
[Telegraf GitHub repository](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores).
## Usage
```sh
telegraf [global-flags] secrets set [flags] <SECRET_STORE_ID> <SECRET_KEY> <SECRET_VALUE>
```
## Arguments
| Argument | Description |
| :------------------ | :------------------------------------------ |
| **SECRET_STORE_ID** | ID of the secret store to set the secret in |
| **SECRET_KEY** | Key of the secret to set |
| **SECRET_VALUE** | Value of the secret to set |
## Flags
| Flag | | Description |
| :--- | :------- | :---------------- |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}
## Examples
- [Set a secret using the default configuration location](#set-a-secret-using-the-default-configuration-location)
- [Set a secret using a non-default configuration location](#set-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 store the secret in.
- {{% code-placeholder-key %}}`SECRET_KEY`{{% /code-placeholder-key %}}:
The key of the secret to set.
- {{% code-placeholder-key %}}`SECRET_VALUE`{{% /code-placeholder-key %}}:
The value of the secret to set.
- {{% code-placeholder-key %}}`CUSTOM_CONFIG_PATH`{{% /code-placeholder-key %}}:
The non-default filepath to your Telegraf configuration file containing your
secret store definitions.
### Set 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](/telegraf/v1/configuration/#configuration-file-locations).
{{% code-placeholders "SECRET_(STORE_ID|KEY|VALUE)" %}}
```sh
telegraf secrets set SECRET_STORE_ID SECRET_KEY SECRET_VALUE
```
{{% /code-placeholders %}}
### Set a secret using a non-default configuration location
{{% code-placeholders "CUSTOM_CONFIG_PATH|SECRET_(STORE_ID|KEY|VALUE)" %}}
```sh
telegraf \
--config CUSTOM_CONFIG_PATH \
secrets set \
SECRET_STORE_ID \
SECRET_KEY \
SECRET_VALUE
```
{{% /code-placeholders %}}

View File

@ -0,0 +1,27 @@
---
title: telegraf version
description: >
The `telegraf version` command prints the current Telegraf version.
menu:
telegraf_v1_ref:
parent: Telegraf commands
weight: 201
---
The `telegraf version` command prints the current Telegraf version.
## Usage
```sh
telegraf [global-flags] version [flags]
```
## Flags
| Flag | | Description |
| :--- | :------------- | :--------------------------------------------- |
| `-h` | `--help` | Show command help |
{{% caption %}}
_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._
{{% /caption %}}

View File

@ -150,8 +150,9 @@ The `[agent]` section contains the following configuration options:
To use local time, set to `"local"`.
See [timezone options and formats](https://socketloop.com/tutorials/golang-display-list-of-timezones-with-gmt).
- **hostname**: Override default hostname, if empty use `os.Hostname()`.
- **omit_hostname**: If true, do no set the `host` tag in the Telegraf agent.
- **omit_hostname**: If true, do not set the `host` tag in the Telegraf agent.
- **skip_processors_after_aggregators**: If true, processors do not run again
after aggregators. Default is false.
## Input configuration

View File

@ -11,7 +11,178 @@ menu:
weight: 60
---
## v1.29.0 {date="2023-12-11}
## v1.30.1 {date="2024-04-01"}
### Bug fixes
- Chrony (`inputs.chrony`): Remove chronyc dependency in documentation.
- DiskIO (`inputs.diskio`): Add missing udev properties.
- DNS Query (`inputs.dns_query`):
- Fill out additional record fields.
- Include the canonical CNAME target.
- KNX (`inputs.knx_listener`):
- Ignore GroupValueRead requests.
- Reconnect after connection loss.
- MySQL (`inputs.mysql`):
- Parse boolean values in metric v1 correctly.
- Use correct column-types for Percona 8 user stats.
- NVIDIA SMI (`inputs.nvidia_smi`): Add process info metrics.
- OpenStack(`inputs.openstack`): Resolve regression in block storage and server info.
- PHP-FPM (`inputs.phpfpm`): Add timeout for fcgi.
- Ping (`inputs.ping`): Add option to force ipv4.
- Prometheus (`inputs.prometheus`): Initialize logger of parser.
- S.M.A.R.T. (`inputs.smart`): Improve regexp to support flags with a plus.
- Systemd Units (`inputs.systemd_units`): Handle disabled multi-instance units correctly.
- BigQuery (`outputs.bigquery`): Add scope to bigquery and remove timeout context.
- Avoid count underflow by only counting initialized secrets.
- Ensure watch-config is passed to the Windows service.
### Dependency updates
- Update `github.com/IBM/sarama` from v1.42.2 to v1.43.1.
- Update `github.com/aws/aws-sdk-go-v2` from 1.25.3 to 1.26.0.
- Update `github.com/aws/aws-sdk-go-v2/config` from 1.27.5 to 1.27.9.
- Update `github.com/aws/aws-sdk-go-v2/feature/ec2/imds` from 1.15.2 to 1.16.0.
- Update `github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs` from 1.34.2 to 1.34.3.
- Update `github.com/aws/aws-sdk-go-v2/service/ec2` from 1.149.3 to 1.151.1.
- Update `github.com/aws/aws-sdk-go-v2/service/sts` from 1.28.2 to 1.28.4.
- Update `github.com/docker/docker` from 25.0.0+incompatible to 25.0.5+incompatible.
- Update `github.com/jackc/pgtype` from 1.14.0 to 1.14.2.
- Update `github.com/jackc/pgx/v4` from 4.18.1 to 4.18.2.
- Update `github.com/klauspost/compress` from 1.17.6 to 1.17.7.
- Update `github.com/pion/dtls/v2` from 2.2.8 to 2.2.10.
- Update `github.com/prometheus-community/pro-bing` from 0.3.0 to 0.4.0.
- Update `github.com/prometheus/procfs` from 0.12.0 to 0.13.0.
- Update `github.com/stretchr/testify` v1.8.4 to v1.9.0.
- Update `go.step.sm/crypto` from 0.43.0 to 0.44.1.
- Update `golang.org/x/crypto` from 0.20.0 to 0.21.0.
- Update `gonum.org/v1/gonum` from 0.14.0 to 0.15.0.
- Update `google.golang.org/api` from 0.165.0 to 0.171.0.
- Update `google.golang.org/protobuf` from 1.32.0 to 1.33.0.
- Update `tj-actions/changed-files` from 42 to 43.
## v1.30.0 {date="2024-03-11"}
### Deprecation removals
This release removes the following deprecated plugins:
- `inputs.cassandra`
- `inputs.httpjson`
- `inputs.io`
- `inputs.jolokia`
- `inputs.kafka_consumer_legacy`
- `inputs.snmp_legacy`
- `inputs.tcp_listener`
- `inputs.udp_listener`
- `outputs.riemann_legacy`
Furthermore, the following deprecated plugin options are removed:
- `mountpoints` of `inputs.disk`
- `metric_buffer` of `inputs.mqtt_consumer`
- `metric_buffer` of `inputs.nats_consumer`
- `url` of `outputs.influxdb`
Replacements do exist, so please migrate your configuration in case you are
still using one of these plugins. The [`telegraf config migrate` command](/telegraf/v1/commands/config/migrate/)
can help with migrating to newer plugins.
### Important Changes
- The default read-timeout of `inputs.syslog` of five seconds is not a sensible
default as the plugin will close the connection if the time between
consecutive messages exceeds the timeout. Telegraf 1.30.0+ sets the timeout
to infinite (i.e zero) as this is the expected behavior.
- Telegraf 1.30.0+ correctly sanitize PostgreSQL addresses, which may change the
server tag value for a URI-formatted address that contains spaces, backslashes
or single-quotes in non-redacted parameters.
### New Plugins
#### Outputs
- [Zabbix](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/zabbix) (`outputs.zabbix`)
#### Serializers
- [Binary](https://github.com/influxdata/telegraf/tree/master/plugins/serializers/binary) (`serializers.binary`)
#### Processors
- [SNMP lookup](https://github.com/influxdata/telegraf/tree/master/plugins/processors/snmp_lookup) (`processors.snmp_lookup`)
### Features
- Add loongarch64 nightly and release builds.
- Add `skip_processors_after_aggregators` configuration option to skip
re-running processors after aggregators.
- Allow secrets in headers
- OPCUA (`common.opcua`): Add debug info for nodes not in server namespace.
- Aerospike (`inputs.aerospike`): Deprecate plugin.
- AMD ROCm System Management Interface (`inputs.amd_rocm_smi`):
Add `startup_error_behavior` configuration option.
- Chrony (`inputs.chrony`):
- Allow the collection of additional metrics.
- Remove `chronyc` dependency.
- Kafka Consumer (`inputs.kafka_consumer`): Mark messages that failed parsing.
- Kernel (`inputs.kernel`): Add pressure stall information.
- Modbus (`inputs.modbus`): Add a workaround for unusual string-byte locations.
- Net (`inputs.net`): Add speed metric.
- NVIDIA SMI (`inputs.nvidia_smi`): Add `startup_error_behavior` configuration option.
- Prometheus (`inputs.prometheus`):
- Add internal metrics.
- Add option to limit body length.
- Redfish (`inputs.redfish`): Allow secrets for username/password configuration.
- S.M.A.R.T. (`inputs.smart`): Add a `device_type` tag to differentiate disks
behind a RAID controller.
- SQL Server (`inputs.sqlserver`): Add stolen target memory ratio.
- Systemd Units (`inputs.systemd_units`)
- Support querying unloaded/disabled units.
- Introduce show subcommand for additional data.
- Windows Services (`inputs.win_services`): Make service selection case-insensitive.
- Graphite (`outputs.graphite`): Set the local address to bind to.
- NATS (`outputs.nats`): Introduce NATS Jetstream option.
- Nebius Cloud Monitoring (`outputs.nebius_cloud_monitoring`): Add service
configuration setting.
- Webscoket (`outputs.websocket`): Support secrets in headers.
- CSV (`serializers.csv`): Specify a fixed column order.
### Bug fixes
- Catch panics in input plugin goroutines.
- Reword error message about missing configuration options.
- Docker Log (`inputs.docker_log`): Use the correct name when matching container.
- GNMI (`inputs.gnmi`):
- Add option to infer the path tag from the subscription.
- Handle canonical field-name correctly
- Netflow (`inputs.netflow`): Fallback to IPFIX mappings for Netflow v9.
- PHP-FPM (`inputs.phpfpm`): Continue despite erroneous sockets.
- Prometheus (`inputs.prometheus`): List namespaces only when filtering by namespace.
- Prometheus (`parsers.prometheus`): Do not touch input data for protocol-buffers.
- Override (`processors.override`): Correct TOML tag name.
- Ensure valid statefile in package.
### Dependency updates
- Update all `github.com/aws/aws-sdk-go-v2` dependencies.
- Update `cloud.google.com/go/bigquery` from 1.58.0 to 1.59.1.
- Update `github.com/aws/aws-sdk-go-v2/service/dynamodb` from 1.27.0 to 1.30.2.
- Update `github.com/cloudevents/sdk-go/v2` from 2.15.0 to 2.15.2.
- Update `github.com/eclipse/paho.golang` from 0.20.0 to 0.21.0.
- Update `github.com/microsoft/go-mssqldb` from 1.6.0 to 1.7.0.
- Update `github.com/netsampler/goflow2` from v1.3.6 to v2.1.2.
- Update `github.com/peterbourgon/unixtransport` from 0.0.3 to 0.0.4.
- Update `github.com/prometheus/client_model` from 0.5.0 to 0.6.0.
- Update `github.com/srebhan/cborquery` from v0.0.0-20230626165538-38be85b82316 to v1.0.1.
- Update `github.com/vapourismo/knx-go` from v0.0.0-20240107135439-816b70397a00 to v0.0.0-20240217175130-922a0d50c241.
- Update `go.mongodb.org/mongo-driver` from 1.13.1 to 1.14.0.
- Update `golang.org/x/crypto` from 0.19.0 to 0.20.0.
- Update `modernc.org/sqlite` from 1.28.0 to 1.29.2.
- Update `super-linter/super-linter` from 6.1.1 to 6.3.0.
## v1.29.0 {date="2023-12-11"}
### New Plugins

View File

@ -75,9 +75,9 @@ telegraf:
menu_category: other
list_order: 6
versions: [v1]
latest: v1.29
latest: v1.30
latest_patches:
v1: 1.29.0
v1: 1.30.1
chronograf:
name: Chronograf

View File

@ -25,9 +25,13 @@ input:
- name: Aerospike
id: aerospike
description: |
**Deprecated in favor of the [Prometheus plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/prometheus/README.md)
with the Aerospike Prometheus Exporter.**
The Aerospike input plugin queries Aerospike servers and gets node statistics
and statistics for all configured namespaces.
introduced: 0.2.0
deprecated: 1.30.0
tags: [linux, macos, windows, data-stores]
- name: Alibaba CloudMonitor Service (Aliyun)
@ -252,19 +256,6 @@ input:
introduced: 1.7.0
tags: [linux, macos, windows, messaging]
- name: Cassandra
id: cassandra
description: |
*Deprecated in Telegraf 1.7.0 in favor of the [jolokia2](#jolokia2_agent) input plugin.
See [example Jolokia2/Cassandra configurations](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/jolokia2/examples/cassandra.conf).*
The Cassandra input plugin collects Cassandra 3 / JVM metrics exposed as MBean
attributes through the jolokia REST endpoint.
All metrics are collected for each server configured.
introduced: 0.12.1
deprecated: 1.6.4
tags: [linux, macos, windows, data-stores]
- name: Ceph Storage
id: ceph
description: |
@ -692,17 +683,6 @@ input:
introduced: 1.6.0
tags: [linux, macos, windows, servers, web]
- name: HTTP JSON
id: httpjson
description: |
*Deprecated in Telegraf 1.6.0. Use the [HTTP input plugin](#http).*
The HTTP JSON input plugin collects data from HTTP URLs which respond with JSON.
It flattens the JSON and finds all numeric values, treating them as floats.
introduced: 0.1.6
deprecated: 1.5.3
tags: [linux, macos, windows, servers, web]
- name: HTTP Listener
id: http_listener
description: |
@ -949,14 +929,6 @@ input:
introduced: 1.9.0
tags: [linux, macos, windows, build-deploy]
- name: Jolokia
id: jolokia
description: |
*Deprecated in Telegraf 1.5.0. Use the [Jolokia2 input plugin](#jolokia2_agent).*
introduced: 0.2.1
deprecated: 1.4.5
tags: [linux, macos, windows, networking]
- name: Jolokia2 Agent
id: jolokia2_agent
description: |
@ -1855,15 +1827,6 @@ input:
introduced: 0.10.1
tags: [linux, macos, windows, networking]
- name: SNMP Legacy
id: snmp_legacy
description: |
The SNMP Legacy input plugin gathers metrics from SNMP agents.
*Deprecated in Telegraf 1.0.0. Use the [SNMP input plugin](#snmp).*
introduced: 0.10.1
deprecated: 0.13.1
tags: [linux, macos, windows, networking]
- name: SNMP Trap
id: snmp_trap
description: |
@ -2021,14 +1984,6 @@ input:
introduced: 1.1.2
tags: [linux, macos, windows, logging]
- name: TCP Listener
id: tcp_listener
description: |
*Deprecated in Telegraf 1.3.0. Use the [Socket Listener input plugin](#socket_listener).*
introduced: 0.11.0
deprecated: 1.2.1
tags: [linux, macos, windows, networking, web]
- name: Teamspeak 3
id: teamspeak
description: |
@ -2079,14 +2034,6 @@ input:
introduced: 0.3.0
tags: [linux, macos, windows, servers, web]
- name: UDP Listener
id: udp_listener
description: |
*Deprecated in Telegraf 1.3.0. use the [Socket Listener input plugin](#socket_listener).*
introduced: 0.11.0
deprecated: 1.2.1
tags: [linux, macos, windows, networking]
- name: Unbound
id: unbound
description: |
@ -2620,16 +2567,6 @@ output:
introduced: 1.3.0
tags: [linux, macos, windows, networking, systems]
- name: Riemann Legacy
id: riemann_legacy
description: |
The Riemann Legacy output plugin will be deprecated in a future release,
see [#1878](https://github.com/influxdata/telegraf/issues/1878) for more details & discussion.
link: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/riemann_legacy
introduced: 0.2.3
deprecated: 1.2.1
tags: [linux, macos, windows, applications]
- name: Sensu
id: sensu
description: |