docs-v2/content/shared/influxdb3-write-guides/use-telegraf/_index.md

2.1 KiB

Telegraf is a data collection agent for collecting and reporting metrics. Its vast library of input plugins and "plug-and-play" architecture lets you quickly and easily collect metrics from many different sources.

For a list of available plugins, see Telegraf plugins.

Requirements

Basic Telegraf usage

Telegraf is a plugin-based agent with plugins that are enabled and configured in your Telegraf configuration file (telegraf.conf). Each Telegraf configuration must have at least one input plugin and one output plugin.

Telegraf input plugins retrieve metrics from different sources. Telegraf output plugins write those metrics to a destination.

Use the outputs.influxdb_v2 plugin to connect to the InfluxDB v2 write API included in {{% product-name %}} and write metrics collected by Telegraf to {{< product-name >}}.

{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}

# ...

[[outputs.influxdb_v2]]
  urls = ["http://{{< influxdb/host >}}"]
  token = "AUTH_TOKEN"
  organization = ""
  bucket = "DATABASE_NAME"

# ...

{{% /code-placeholders %}}

Replace the following:

  • {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: the name of the database to write data to

  • {{% code-placeholder-key %}}AUTH_TOKEN{{% /code-placeholder-key %}}: your {{< product-name >}} authorization token. Store this in a secret store or environment variable to avoid exposing the raw token string.

    [!Note] While in beta, {{< product-name >}} does not require an authorization token. For the token option, provide an arbitrary, non-empty token string.

See how to Configure Telegraf to write to {{% product-name %}}.

Use Telegraf with InfluxDB

{{< children >}}

{{< influxdbu "telegraf-102" >}}