Documentation

Update a Telegraf configuration

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:

Telegraf doesn’t detect changes to remote configurations. If you edit a remote configuration, you must restart Telegraf or send it a SIGHUP command for your changes to take effect.

Use the InfluxDB UI

Update the name or description of a configuration

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

  2. Hover over the configuration you want to edit and click to update the name or description.

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

Edit the configuration file directly in the UI

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

  2. To edit the configuration file: a. Click the name of the configuration. b. Add or update Telegraf plugin settings in the window that appears.

    The text editor window doesn’t detect if any plugins or settings are misconfigured. Any errors in your configuration that may cause Telegraf to fail when you restart it.

    c. Click Save Changes and then Save again to confirm.

  3. To apply the updated configuration, restart Telegraf. To find the exact command to start Telegraf, click Setup Instructions on the Telegraf page.

Download and verify the configuration file

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

  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. Review the configuration file. 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.

  6. To apply the updated configuration, restart Telegraf. To find the exact command to start Telegraf, click Setup Instructions on the Telegraf page.

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

If a name and description are not provided, they are replaced with empty strings.

# 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

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.