Skip to main content

Build a configuration with flow builder

The Passport Flow Builder is a low-code tool for building configurations for your agents. These configurations can be assigned to the corresponding agents managed by the Agent Manager.

Step 1: Start a Config​

To get started with the flow-builder in Passport, choose from one of the methods below on the Passport > Configurations page:

Import​

Import a configuration file from your local machine.

configurations-import

Create configuration​

Use this to copy/paste your config into a code block or start fresh with the low-code builder if using telegraf or fluent-bit.

Step 2: Build the configuration​

Once in the flow builder, what you see will be determined in part by which agent you are creating a config for. However, some elements are common to all.

flow builder

In the left menu, you will see a list of supported plugins broken out by the plugin category supported by the target agent.

You can filter the results by using the search box. To use a plugin, simply drag it from the left menu and drop it over a compatible node on the canvas. The plugins that can connect are agent-specific.

Example

When working with Telegraf, you can drag an output plugin over an input plugin, but not the other way around because the output plugin is the last plugin type in that agent's plugin pipeline model.

Your configurations will appear on the right.

To save, click the Save button in the canvas button list:

flow builder

Once the configuration file is imported, it will be displayed on the Passport > Configurations list page.

Assigning a configuration​

After the Agent Manager has been installed and some collection agents are now being managed, you can start assigning configuration files to the collection agents under management.

note

If the Agent Manager is Disconnected during this process, once it comes back online it will pull down any assigned configs.

Configuration assignment statuses:

  • New (Recently assigned to an Agent Manager and the config is waiting for the next check-in from the Agent Manager which is every minute.)
  • Active (The Agent Manager has updated the configuration file for the selected collection agent)
  • Pending (The Agent Manager is in the process of applying the configuration)
  • Error (The Agent Manager encountered an error applying the configuration)
  • Canceled (The assignment was replaced by another new assignment before the Agent Manager had a chance to see it)
  • Inactive (The assignment was previously active but has now been replaced)

Assigning a configuration file can either be done from the specific file's details page or the Agent Manager page.

configurations-assign-both-ways

Configuration details page​

From a Passport > Configurations details page, select the Assign button to view all possible agents that can be assigned this configuration.

configurations-assign

Agent Manager page​

Assign configuration file

All supported agent-type configuration files will be listed. Choose one and select Assign.

Assign configuration file

Next, the assignment will be pulled down by the Agent Manager on its next check which is every 60 seconds. When the configuration file has been updated on the collection agent, the status will change to Active.

If the Agent Manager is currently Disconnected, when it next checks in it will pull down the new config file.

Assign configuration file