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/influxdb/cloud-serverless/write-data/use-telegraf/configure/_index.md

4.6 KiB
Raw Blame History

title seotitle description menu weight influxdb/cloud-serverless/tags related alt_engine aliases
Configure Telegraf for InfluxDB Configure Telegraf to write to InfluxDB Telegraf is a plugin-based agent with plugins that are enabled and configured in your Telegraf configuration file (`telegraf.conf`). Update existing or create new Telegraf configurations to use the `influxdb_v2` output plugin to write to InfluxDB. Start Telegraf using the custom configuration.
influxdb_cloud_serverless
name parent
Configure Telegraf Use Telegraf
101
telegraf
/{{< latest "telegraf" >}}/plugins/
/influxdb/cloud/write-data/no-code/use-telegraf/manual-config/
/influxdb/cloud-serverless/write-data/use-telegraf/manual-config/

Use the Telegraf influxdb_v2 output plugin to collect and write metrics to {{< cloud-name >}}. Learn how to enable the plugin in new and existing Telegraf configurations, and then start Telegraf using the custom configuration file.

{{% note %}} View the requirements for using Telegraf with {{< cloud-name >}}. {{% /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.

This guide assumes you followed Setup instructions in the Get Started guide to set up InfluxDB and configure authentication credentials.

Add Telegraf plugins

To add any of the available [Telegraf plugins](/{{< latest "telegraf" >}}/plugins/), follow the steps below.

  1. Find the plugin you want to enable from the complete list of available [Telegraf plugins](/{{< latest "telegraf" >}}/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.
  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 {{< cloud-name >}}, enable the influxdb_v2 output plugin in the telegraf.conf.

{{% code-placeholders "BUCKET_NAME" %}}

[[outputs.influxdb_v2]]
  urls = ["https://cloud2.influxdata.com"]
  # INFLUX_TOKEN is an environment variable you created for your API WRITE token
  token = "${INFLUX_TOKEN}"
  organization = ""
  bucket = "BUCKET_NAME"

{{% /code-placeholders %}}

Replace the following:

  • BUCKET_NAME: the name of the InfluxDB bucket to write data to

The InfluxDB output plugin configuration contains the following options:

urls

An array of URL strings. To write to {{% cloud-name %}}, include your {{% cloud-name %}} region URL using the HTTPS protocol:

["https://cloud2.influxdata.com"]
token

Your {{% cloud-name %}} API token with write permission to the database.

In the examples, INFLUX_TOKEN is an environment variable assigned to a API token that has write permission to the database.

organization

For {{% cloud-name %}}, set this to an empty string ("").

bucket

The name of the {{% cloud-name %}} bucket to write data to.

{{% note %}}

Write to InfluxDB v1.x and {{< cloud-name >}}

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 your {{< cloud-name >}} bucket. {{% /note %}}

Start Telegraf

Start the Telegraf service using the --config flag to specify the location of your telegraf.conf.

telegraf --config /path/to/custom/telegraf.conf