Define agent reporting rules
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. We welcome any and all contributions.
Reporting rules define how long an agent can go without sending a heartbeat before Telegraf Controller changes its status to Not Reporting. They can also automatically delete agents that haven’t reported in a specified amount of time.
Telegraf Controller requires a default reporting rule. Newly created agents are automatically assigned to the current default reporting rule.
Manage reporting rules in the Reporting Rules section of Controller, then assign them to agents from either the agent list or an agent details page.
- Create a reporting rule
- Update a reporting rule
- Delete a reporting rule
- Set a default reporting rule
- Assign a reporting rule to agents
Create a reporting rule
- In Telegraf Controller, go to Reporting Rules.
- Select + Add Rule.
- Enter the following:
- Description: Reporting rule description
- Not Reporting Threshold: The maximum time an agent can go without reporting before Controller assigns the “Not Reporting” status.
- Auto-delete agents: Enable to automatically delete agents that haven’t reported in the defined auto-delete threshold.
- Default Rule: Enable to make the rule the default reporting rule.
- Save the rule.
Update a reporting rule
- In Reporting Rules, click the More button (⋮) of the rule you want to update.
- Select Edit.
- Edit the description, not reporting threshold, auto-delete settings, or make the rule the default reporting rule.
- Save your changes.
Delete a reporting rule
- In Reporting Rules, click the More button (⋮) of the rule you want to delete.
- Select Delete and confirm.
You cannot delete the default reporting rule
To delete a reporting rule that is currently the default rule, first assign a new rule as the default reporting rule.
Agents assigned to a deleted reporting rule
When you delete a reporting rule, any agents assigned to the deleted rule automatically inherit the default reporting rule.
Set a default reporting rule
From the reporting rules list
- In Reporting Rules, click the More button (⋮) of the rule you want to make the default.
- Select Make Default.
From reporting rule details
- In Reporting Rules, click the More button (⋮) of the rule you want to make the default.
- Select Edit.
- Toggle Default Rule to true.
- Save your changes.
Assign a reporting rule to agents
From the agent list
- In Agents, select one or more agents.
- Select Assign Rule.
- Choose a rule and assign it.
From an agent details page
- In Agents, click the More button (⋮) for an agent and select View Details.
- In the Reporting Rule section, select Change.
- Choose a rule and apply it.
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 Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.