5.1 KiB
title | seotitle | description | aliases | menu | weight | related | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Automatically configure Telegraf | Automatically configure Telegraf for InfluxDB v2.1 | Use the InfluxDB UI to automatically generate a Telegraf configuration, then start Telegraf using the generated configuration file. |
|
|
201 |
|
The InfluxDB user interface (UI) can automatically create Telegraf configuration files based on user-selected Telegraf plugins. This article describes how to create a Telegraf configuration in the InfluxDB UI and start Telegraf using the generated configuration file.
{{< youtube M8KP7FAb2L0 >}}
{{% note %}} View the requirements for using Telegraf with InfluxDB v2.1. {{% /note %}}
Create a Telegraf configuration
-
Open the InfluxDB UI (default: localhost:8086).
-
In the navigation menu on the left, select Data (Load Data) > Telegraf.
{{< nav-icon "load data" >}}
-
Click {{< icon "plus" >}} Create Configuration.
-
In the Bucket dropdown, select the bucket where Telegraf will store collected data.
-
Select one or more of the available plugin groups and click Continue.
-
Review the list of Plugins to Configure for configuration requirements. Plugins listed with a {{< icon "check" >}} require no additional configuration. To configure a plugin or access plugin documentation, click the plugin name.
-
Provide a Telegraf Configuration Name and an optional Telegraf Configuration Description.
-
Adjust configuration settings as needed. To find configuration settings for a specific plugin, see Telegraf plugins.
-
Click Save and Test.
-
The Test Your Configuration page provides instructions for how to start Telegraf using the generated configuration. See Start Telegraf below for detailed information about what each step does.
-
Once Telegraf is running, click Listen for Data to confirm Telegraf is successfully sending data to InfluxDB. Once confirmed, a Connection Found! message appears.
-
Click Finish. Your Telegraf configuration name and the associated bucket name appears in the list of Telegraf configurations.
Windows
If you plan to monitor a Windows host using the System plugin, you must complete the following steps.
-
In the list of Telegraf configurations, double-click your Telegraf configuration, and then click Download Config.
-
Open the downloaded Telegraf configuration file and replace the
[[inputs.processes]]
plugin with one of the following Windows plugins, depending on your Windows configuration: -
Save the file and place it in a directory that telegraf.exe can access.
Start Telegraf
Requests to the InfluxDB v2 API must include an API token. A token identifies specific permissions to the InfluxDB instance.
Configure your token as an environment variable
-
Find your API token. For information about viewing tokens, see View tokens.
-
To configure your API token as the
INFLUX_TOKEN
environment variable, run the command appropriate for your operating system and command-line tool:
{{< tabs-wrapper >}} {{% tabs %}} macOS or Linux Windows {{% /tabs %}}
{{% tab-content %}}
export INFLUX_TOKEN=YourAuthenticationToken
{{% /tab-content %}}
{{% tab-content %}}
{{< code-tabs-wrapper >}} {{% code-tabs %}} PowerShell CMD {{% /code-tabs %}}
{{% code-tab-content %}}
$env:INFLUX_TOKEN = "YourAuthenticationToken"
{{% /code-tab-content %}}
{{% code-tab-content %}}
set INFLUX_TOKEN=YourAuthenticationToken
# Make sure to include a space character at the end of this command.
{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}
{{% /tab-content %}} {{< /tabs-wrapper >}}
Start the Telegraf service
Start the Telegraf service using the -config
flag to specify the location of the generated Telegraf configuration file.
- For Windows, the location is always a local file path.
- For Linux and macOS, the location can be a local file path or URL.
Telegraf starts using the Telegraf configuration pulled from InfluxDB API.
{{% note %}} InfluxDB host URLs and ports differ between InfluxDB OSS and InfluxDB Cloud. For the exact command, see the Telegraf configuration Setup Instructions in the InfluxDB UI. {{% /note %}}
telegraf -config http://localhost:8086/api/v2/telegrafs/0xoX00oOx0xoX00o
Manage Telegraf configurations
For more information about managing Telegraf configurations in InfluxDB, see Telegraf configurations.