Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/v2.0/telegraf-configs/update.md

3.0 KiB
Raw Blame History

title description weight menu aliases
Update a Telegraf configuration Use the InfluxDB user interface (UI) or the [`influx` CLI](/v2.0/reference/cli/influx/) to update InfluxDB Telegraf configurations. 103
v2_0
name parent
Update a config Telegraf configurations
/v2.0/write-data/no-code/use-telegraf/auto-config/update-telegraf-config/
/v2.0/collect-data/use-telegraf/auto-config/update-telegraf-config

Use the InfluxDB user interface (UI) or the influx CLI to update InfluxDB Telegraf configurations.

To update a Telegraf configuration, do one of the following:

Use the InfluxDB UI

The InfluxDB UI lets you update the name or description of a Telegraf configuration.

{{% note %}} You cannot modify Telegraf settings in existing Telegraf configurations directly through the InfluxDB UI. To modify existing Telegraf configuration settings, use the influx CLI to update the Telegraf configuration. {{% /note %}}

  1. In the navigation menu on the left, select Data (Load Data) > Telegraf.

    {{< nav-icon "load data" >}}

  2. Hover over the configuration you want to edit and click {{< icon "pencil" >}} to update the name or description.

  3. Press Return or click out of the editable field to save your changes.

Use the influx CLI

Use the influx telegrafs update command to update an existing InfluxDB Telegraf configuration name, description, or settings from a Telegraf configuration file on your local machine.

Provide the following:

  • Telegraf configuration ID (shown in the output of influx telegrafs)
  • Telegraf configuration name
  • Telegraf configuration description
  • Telegraf configuration file

{{% warn %}} If a name and description are not provided, they are replaced with empty strings. {{% /warn %}}

# Syntax
influx telegrafs update \
  -i <telegraf-config-id> \
  -n <telegraf-config-name> \
  -d <telegraf-config-description> \
  -f /path/to/telegraf.conf

# Example
influx telegrafs update \
  -i 12ab34de56fg78hi
  -n "Example Telegraf config"
  -d "This is a description for an example Telegraf configuration."
  -f /path/to/telegraf.conf

Customize an existing Telegraf configuration

  1. In the navigation menu on the left, select Data (Load Data) > Telegraf.

    {{< nav-icon "load data" >}}

  2. Click the name of the Telegraf configuration to customize.

  3. Click Download Config to download the Telegraf configuration file to your local machine.

  4. Add or update Telegraf plugin settings and save your changes.

  5. Use the influx telegrafs update command to upload your modified Telegraf configuration to InfluxDB and replace the existing configuration.