Manually configure Telegraf
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.
View the requirements for using Telegraf with InfluxDB v2.0.
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 for a complete list of available plugins.
Manually add Telegraf plugins
To manually add any of the available Telegraf plugins, follow the steps below.
- Find the plugin you want to enable from the complete list of available Telegraf plugins.
- 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.
- 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
in the telegraf.conf
.
To find an example InfluxDB v2 output plugin configuration in the UI:
In the navigation menu on the left, select Load Data > Telegraf.
Click InfluxDB Output Plugin.
Click Copy to Clipboard to copy the example configuration or Download Config to save a copy.
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 for information about which URLs to use. InfluxDB Cloud requires HTTPS.
token
Your InfluxDB v2.0 authorization token. For information about viewing tokens, see View tokens.
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.
export INFLUX_TOKEN=YourAuthenticationToken
$env:INFLUX_TOKEN = "YourAuthenticationToken"
set INFLUX_TOKEN=YourAuthenticationToken
# Make sure to include a space character at the end of this command.
See the example telegraf.conf
below.
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.
# ...
[[outputs.influxdb_v2]]
urls = ["https://cloud2.influxdata.com"]
token = "$INFLUX_TOKEN"
organization = "example-org"
bucket = "example-bucket"
# ...
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.
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
or influx telegrafs update
commands.
For more information, see:
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
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.