---
title: Use the Telegraf Builder
description: Use the Telegraf Builder visual interface in Telegraf Controller to manage and configure Telegraf plugins.
url: https://docs.influxdata.com/telegraf/controller/configs/ui/telegraf-builder/
estimated_tokens: 1557
publisher: InfluxData
canonical: https://docs.influxdata.com/telegraf/controller/configs/ui/telegraf-builder/
date: '2025-12-31T14:49:32-07:00'
lastmod: '2025-12-31T14:49:32-07:00'
---

#### Telegraf Controller is in Public Beta

Telegraf Controller is in public beta and will be part of the future Telegraf Enterprise offering.
While in beta, Telegraf Controller is **not meant for production use**.
The Telegraf Controller documentation is a work in progress, and we are actively
working to improve it. If you have any questions or suggestions, please[submit an issue](https://github.com/influxdata/docs-v2/issues/new?labels=Telegraf%20Controller).
We welcome any and all contributions.

Beta expectations

* **No configuration or agent limits**  
  While in beta, Telegraf Controller doesn't place any limits on the
  number of configurations you can store or the number of Telegraf
  agents you can track. However, upon being generally available,
  the free distribution of Telegraf Controller will have limits
  introduced, with the option to increase limits through a
  Telegraf Enterprise license.
* **Potential breaking changes**  
  While in beta, we will do our best to no longer make breaking
  changes to Telegraf Controller, however, they may be necessary.
  The majority of changes we make will be additive and non-breaking,
  and include any necessary migrations. When we do need to make
  breaking changes, we will do our best to communicate them clearly
  and in advance to minimize disruption.
* **Flexible release schedule**  
  While in beta, we will continue to create new releases of
  Telegraf Controller, but likely at irregular intervals. We will provide[Telegraf Controller release notes](/telegraf/controller/reference/release-notes/)to make it easy to track updates.

Provide beta feedback

* Use the **Feedback** feature in the Telegraf Controller UI.
* [Join the InfluxDB Community Slack](https://influxdata.com/slack) and post feedback in the **#telegraf-enterprise-alpha** channel.
* Post feedback in the [InfluxData Community](https://community.influxdata.com).

Join our public channels

* [InfluxDB Community Slack *(Preferred)*](https://influxdata.com/slack)
* [InfluxData Community](https://community.influxdata.com)
* [InfluxDB Subreddit](https://reddit.com/r/influxdb)

The **Telegraf Builder** is a visual interface for managing and configuring
Telegraf plugins in a configuration. The builder is available when creating or
updating a configuration.

<img src="/img/telegraf/controller-telegraf-builder.png" alt="Telegraf Builder in Telegraf Controller" width="948">

The Telegraf builder is divided into two main panes:

* [Plugin Library pane](#plugin-library-pane): Search for and add supported plugins
* [Configuration pane](#configuration-pane): Manage agent and plugin settings

## Plugin Library pane

The **Plugin Library** pane provides a list of all Telegraf plugins supported
in the builder grouped by plugin type.

#### The Telegraf Builder does not support all Telegraf plugins

We are in the process of adding support for more Telegraf plugins in the
Telegraf Builder. You can use plugins that are not currently supported by the
builder, but you must add and edit them with the Code Editor.

* **Search plugins**: Use the search bar in the Plugin Library pane to search
  for Telegraf plugins. Search by plugin name, identifier, or description.
* **Add plugins to your configuration**: Click  next to the
  plugin to add it to your configuration.

## Configuration pane

The **Configuration** pane lets you manage agent and plugin-specific settings.
Configuration options and plugins are each represented by “cards”.
Click on a card or expand or hide its contents.

Each configuration has at least two cards: [Agent Settings](#agent-settings)and [Global Tags](#global-tags).

### Agent settings

Agent settings are those that specify how the agent runs rather than
plugin-specific settings. Agent settings only need to be included in a
configuration when they vary from the[default Telegraf agent settings](/telegraf/v1/configuration/#agent-configuration).

**To include agent settings in your configuration:**

1. On the **Agent Settings** card, enable the **Include in config** toggle.
2. Define custom settings for any of the available Telegraf agent settings.

### Global tags

Telegraf applies global tags to all metrics that it emits. Global tags are not
required and only need to be included in a configuration when set.

**To include global tags in your configuration:**

1. On the **Global Tags** card, enable the **Include in config** toggle.
2. Click  **Add Global Tag**.
3. Provide a key and a value for the global tag.
4. Repeat steps 2-3 for additional global tags.

### Plugin cards

The Telegraf Builder represents each Telegraf plugin as a card. Plugin cards
have three tabs:

* [Plugin](#plugin): Plugin-specific settings
* [Customize](#customize): Plugin customization options
* [Filter](#filter): Plugin metric filters

#### Plugin

The **Plugin** tab in a plugin card lets you customize settings specific
to that plugin.

> [!Note]
> You can use [dynamic values](/telegraf/controller/configs/dynamic-values/)when defining plugin settings in the Telegraf Builder.

#### Customize

The **Customize** tab in a plugin card lets you apply plugin customizations
including the following:

* **Add a plugin alias**: Aliases help to identify plugins in your
  configuration. They are especially helpful when you have more than one of the
  same plugin. When you define a plugin alias, the builder uses the alias as the
  plugin name on the plugin card.

* **Add configuration labels**: Telegraf configuration labels let you label and
  select what plugins to run when starting Telegraf. For more information about
  using labels and selectors, see[Plugin selection via labels and selectors](/telegraf/v1/configuration/#plugin-selection-via-labels-and-selectors)

* **Other customizations specific to the plugin type**

#### Filter

The **Filter** tab on a plugin card lets you add metric filters to the plugin.
These filters include `namepass`, `namedrop`, `tagpass`, `tagdrop`, and others.

For more information about using Telegraf plugin filters, see[Metric filtering](/telegraf/v1/configuration/#metric-filtering).

#### Remove a plugin from the configuration

To remove a plugin from the configuration, click the icon on the plugin card.
