151 lines
5.4 KiB
Markdown
151 lines
5.4 KiB
Markdown
---
|
|
title: Automatically configure Telegraf
|
|
seotitle: Automatically configure Telegraf for InfluxDB v2.0
|
|
description: >
|
|
Use the InfluxDB UI to automatically generate a Telegraf configuration,
|
|
then start Telegraf using the generated configuration file.
|
|
menu:
|
|
influxdb_cloud:
|
|
parent: Telegraf (agent)
|
|
weight: 201
|
|
related:
|
|
- /influxdb/cloud/tools/telegraf-configs/create/
|
|
# alt_links:
|
|
# cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/configure/auto-config/
|
|
---
|
|
|
|
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.
|
|
|
|
{{% note %}}
|
|
Only a subset of plugins are configurable using the InfluxDB UI.
|
|
To use plugins other than those listed, you must [manually configure Telegraf](/influxdb/cloud/write-data/no-code/use-telegraf/manual-config).
|
|
{{% /note %}}
|
|
|
|
{{% note %}}
|
|
_View the [requirements](/influxdb/cloud/write-data/no-code/use-telegraf#requirements)
|
|
for using Telegraf with InfluxDB v2.0._
|
|
{{% /note %}}
|
|
|
|
## Create a Telegraf configuration
|
|
|
|
1. Open the InfluxDB Cloud UI.
|
|
2. In the navigation menu on the left, select **Data** (**Load Data**) > **Telegraf**.
|
|
|
|
{{< nav-icon "load data" >}}
|
|
|
|
4. Click **{{< icon "plus" >}} Create Configuration**.
|
|
5. In the **Bucket** dropdown, select the bucket where Telegraf will store collected data.
|
|
6. Select one or more of the available plugin groups and click **Continue**.
|
|
7. Review the list of **Plugins to Configure** for configuration requirements.
|
|
Plugins listed with a <span style="color:#32B08C">{{< icon "check" >}}</span>
|
|
require no additional configuration.
|
|
To configure a plugin or access plugin documentation, click the plugin name.
|
|
|
|
{{% note %}}
|
|
Not all available plugins are listed on this screen. For more information on manually configuring additional plugins, see [Manually add Telegraf plugins](/influxdb/cloud/write-data/no-code/use-telegraf/manual-config/).
|
|
{{% /note %}}
|
|
|
|
8. Provide a **Telegraf Configuration Name** and an optional **Telegraf Configuration Description**.
|
|
9. Click **Create and Verify**.
|
|
10. The **Test Your Configuration** page provides instructions for how to start
|
|
Telegraf using the generated configuration.
|
|
_See [Start Telegraf](#start-telegraf) below for detailed information about what each step does._
|
|
11. Once Telegraf is running, click **Listen for Data** to confirm Telegraf is successfully
|
|
sending data to InfluxDB.
|
|
Once confirmed, a **Connection Found!** message appears.
|
|
12. Click **Finish**. Your Telegraf configuration name and the associated bucket name appears
|
|
in the list of Telegraf configurations.
|
|
|
|
{{% note %}}
|
|
|
|
### Windows
|
|
|
|
If you plan to monitor a Windows host using the System plugin, you must complete the following steps.
|
|
|
|
1. In the list of Telegraf configurations, double-click your
|
|
Telegraf configuration, and then click **Download Config**.
|
|
2. Open the downloaded Telegraf configuration file and replace the `[[inputs.processes]]` plugin with one of the following Windows plugins, depending on your Windows configuration:
|
|
|
|
- [`[[inputs.win_perf_counters]]`](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_perf_counters)
|
|
- [`[[inputs.win_services]]`](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_services)
|
|
|
|
3. Save the file and place it in a directory that **telegraf.exe** can access.
|
|
|
|
{{% /note %}}
|
|
|
|
## Start Telegraf
|
|
|
|
Requests to the [InfluxDB v2 API](/influxdb/cloud/reference/api/) must include an API token.
|
|
A token identifies specific permissions to the InfluxDB instance.
|
|
|
|
### Configure your token as an environment variable
|
|
|
|
1. Find your API token. _For information about viewing tokens, see [View tokens](/influxdb/cloud/admin/tokens/view-tokens/)._
|
|
|
|
2. To configure your 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 %}}
|
|
```sh
|
|
export INFLUX_TOKEN=YourAuthenticationToken
|
|
```
|
|
{{% /tab-content %}}
|
|
|
|
{{% tab-content %}}
|
|
|
|
{{< code-tabs-wrapper >}}
|
|
{{% code-tabs %}}
|
|
[PowerShell](#)
|
|
[CMD](#)
|
|
{{% /code-tabs %}}
|
|
|
|
{{% code-tab-content %}}
|
|
```sh
|
|
$env:INFLUX_TOKEN = "YourAuthenticationToken"
|
|
```
|
|
{{% /code-tab-content %}}
|
|
|
|
{{% code-tab-content %}}
|
|
```sh
|
|
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 >}}
|
|
|
|
{{< youtube qFS2zANwIrc >}}
|
|
|
|
### 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 %}}
|
|
|
|
```sh
|
|
telegraf -config https://cloud2.influxdata.com/api/v2/telegrafs/0xoX00oOx0xoX00o
|
|
```
|
|
|
|
## Manage Telegraf configurations
|
|
|
|
For more information about managing Telegraf configurations in InfluxDB, see
|
|
[Telegraf configurations](/influxdb/cloud/tools/telegraf-configs/).
|