3.7 KiB
| title | description | menu | weight | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Define agent reporting rules | Define reporting rules that determine when Telegraf Controller marks agents as not reporting and optionally automatically delete not reporting agents. |
|
103 |
Reporting rules define how long an agent can go without sending a heartbeat before {{% product-name %}} changes its status to Not Reporting. They can also automatically delete agents that haven't reported in a specified amount of time.
{{% product-name %}} 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 {{% product-name "short" %}}, 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 {{% product-name "short" %}} 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 ({{% icon "tc-more" %}}) 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 ({{% icon "tc-more" %}}) of the rule you want to delete.
- Select Delete and confirm.
[!Important]
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 ({{% icon "tc-more" %}}) of the rule you want to make the default.
- Select Make Default.
From reporting rule details
- In Reporting Rules, click the More button ({{% icon "tc-more" %}}) 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 ({{% icon "tc-more" %}}) for an agent and select View Details.
- In the Reporting Rule section, select Change.
- Choose a rule and apply it.