166 lines
5.7 KiB
Markdown
166 lines
5.7 KiB
Markdown
---
|
|
title: Manually configure Telegraf
|
|
seotitle: Manually configure Telegraf for InfluxDB v2.0
|
|
description: >
|
|
Update existing or create new Telegraf configurations to use the `influxdb_v2`
|
|
output plugin to write to InfluxDB v2.0.
|
|
Start Telegraf using the custom configuration.
|
|
aliases:
|
|
- /influxdb/cloud/collect-data/use-telegraf/manual-config
|
|
- /influxdb/cloud/write-data/use-telegraf/manual-config
|
|
menu:
|
|
influxdb_cloud:
|
|
parent: Telegraf (agent)
|
|
weight: 202
|
|
influxdb/cloud/tags: [manually, plugin, mqtt]
|
|
related:
|
|
- /telegraf/v1/plugins/
|
|
- /influxdb/cloud/tools/telegraf-configs/create/
|
|
- /influxdb/cloud/tools/telegraf-configs/update/
|
|
alt_links:
|
|
cloud-serverless: /influxdb3/cloud-serverless/write-data/use-telegraf/configure/
|
|
cloud-dedicated: /influxdb3/cloud-dedicated/write-data/use-telegraf/configure/
|
|
clustered: /influxdb3/clustered/write-data/use-telegraf/configure/
|
|
---
|
|
|
|
Use the Telegraf `influxdb_v2` output plugin to collect and write metrics into an InfluxDB v2.0 bucket.
|
|
This article describes how to enable the `influxdb_v2` output plugin in new and existing Telegraf configurations,
|
|
then start Telegraf using the custom configuration file.
|
|
|
|
{{< youtube qFS2zANwIrc >}}
|
|
|
|
{{% note %}}
|
|
_View the [requirements](/influxdb/cloud/write-data/no-code/use-telegraf#requirements)
|
|
for using Telegraf with InfluxDB v2.0._
|
|
{{% /note %}}
|
|
|
|
## Configure Telegraf input and output plugins
|
|
Configure Telegraf input and output plugins in the Telegraf configuration file (typically named `telegraf.conf`).
|
|
Input plugins collect metrics.
|
|
Output plugins define destinations where metrics are sent.
|
|
|
|
_See [Telegraf plugins](/telegraf/v1/plugins/) for a complete list of available plugins._
|
|
|
|
### Manually add Telegraf plugins
|
|
|
|
To manually add any of the available [Telegraf plugins](/telegraf/v1/plugins/), follow the steps below.
|
|
|
|
1. Find the plugin you want to enable from the complete list of available [Telegraf plugins](/telegraf/v1/plugins/).
|
|
2. Click **View** to the right of the plugin name to open the plugin page on GitHub. For example, view the MQTT plugin GitHub page [here](https://github.com/influxdata/telegraf/blob/release-1.14/plugins/inputs/mqtt_consumer/README.md).
|
|
3. Copy and paste the example configuration into your Telegraf configuration file (typically named `telegraf.conf`).
|
|
|
|
### Enable and configure the InfluxDB v2 output plugin
|
|
|
|
To send data to an InfluxDB v2.0 instance, enable in the
|
|
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
|
|
in the `telegraf.conf`.
|
|
|
|
To find an example InfluxDB v2 output plugin configuration in the UI:
|
|
|
|
1. In the navigation menu on the left, select **Load Data** > **Telegraf**.
|
|
|
|
{{< nav-icon "load data" >}}
|
|
|
|
2. Click **InfluxDB Output Plugin**.
|
|
3. Click **Copy to Clipboard** to copy the example configuration or **Download Config** to save a copy.
|
|
4. Paste the example configuration into your `telegraf.conf` and specify the options below.
|
|
|
|
The InfluxDB output plugin configuration contains the following options:
|
|
|
|
##### urls
|
|
An array of URLs for your InfluxDB v2.0 instances.
|
|
See [InfluxDB URLs](/influxdb/cloud/reference/urls/) for information about which URLs to use.
|
|
**{{< product-name "short">}} requires HTTPS**.
|
|
|
|
##### token
|
|
Your InfluxDB v2.0 authorization token.
|
|
For information about viewing tokens, see [View tokens](/influxdb/cloud/admin/tokens/view-tokens/).
|
|
|
|
{{% note %}}
|
|
###### Avoid storing tokens in `telegraf.conf`
|
|
We recommend storing your tokens by setting the `INFLUX_TOKEN` environment variable and including the environment variable in your configuration file.
|
|
|
|
{{< 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 >}}
|
|
|
|
_See the [example `telegraf.conf` below](#example-influxdb_v2-configuration)._
|
|
{{% /note %}}
|
|
|
|
##### organization
|
|
The name of the organization that owns the target bucket.
|
|
|
|
##### bucket
|
|
The name of the bucket to write data to.
|
|
|
|
#### Example influxdb_v2 configuration
|
|
The example below illustrates an `influxdb_v2` configuration.
|
|
|
|
```toml
|
|
# ...
|
|
|
|
[[outputs.influxdb_v2]]
|
|
urls = ["https://cloud2.influxdata.com"]
|
|
token = "$INFLUX_TOKEN"
|
|
organization = "example-org"
|
|
bucket = "example-bucket"
|
|
|
|
# ...
|
|
```
|
|
|
|
{{% note %}}
|
|
##### Write to InfluxDB v1.x and InfluxDB Cloud
|
|
If a Telegraf agent is already writing to an InfluxDB v1.x database,
|
|
enabling the InfluxDB v2 output plugin will write data to both v1.x and v2.0 instances.
|
|
{{% /note %}}
|
|
|
|
## Add a custom Telegraf configuration to InfluxDB
|
|
To add a custom or manually configured Telegraf configuration to your collection
|
|
of Telegraf configurations in InfluxDB, use the [`influx telegrafs create`](/influxdb/cloud/reference/cli/influx/telegrafs/create/)
|
|
or [`influx telegrafs update`](/influxdb/cloud/reference/cli/influx/telegrafs/update/) commands.
|
|
For more information, see:
|
|
|
|
- [Create a Telegraf configuration](/influxdb/cloud/tools/telegraf-configs/create/#use-the-influx-cli)
|
|
- [Update a Telegraf configuration](/influxdb/cloud/tools/telegraf-configs/update/#use-the-influx-cli)
|
|
|
|
## Start Telegraf
|
|
|
|
Start the Telegraf service using the `--config` flag to specify the location of your `telegraf.conf`.
|
|
|
|
```sh
|
|
telegraf --config /path/to/custom/telegraf.conf
|
|
```
|