Alerting Policies (Node Level)

KubeSphere provides alerting policies for nodes and workloads. This tutorial demonstrates how to create alerting policies for nodes in a cluster. See Alerting Policy (Workload Level) to learn how to configure alerting policies for workloads.

KubeSphere also has built-in policies which will trigger alerts if conditions defined for these policies are met. On the Built-in Policies tab, you can click a policy to see its details. Note that they cannot be directly deleted or edited on the console.

Prerequisites

• You have enabled KubeSphere Alerting.
• To receive alert notifications, you must configure a notification channel beforehand.
• You need to create a user (cluster-admin) and grant it the clusters-admin role. For more information, see Create Workspaces, Projects, Users and Roles.
• You have workloads in your cluster. If they are not ready, see Deploy and Access Bookinfo to create a sample app.

Create an Alerting Policy

1. Log in to the console as cluster-admin. Click Platform in the upper-left corner, and then click Cluster Management.

2. Go to Alerting Policies under Monitoring & Alerting, and then click Create.

3. In the displayed dialog box, provide the basic information as follows. Click Next to continue.

   • Name. A concise and clear name as its unique identifier, such as node-alert.
   • Alias. Help you distinguish alerting policies better.
   • Threshold Duration (min). The status of the alerting policy becomes Firing when the duration of the condition configured in the alerting rule reaches the threshold.
   • Severity. Allowed values include Warning, Error and Critical, providing an indication of how serious an alert is.
   • Description. A brief introduction to the alerting policy.

4. On the Rule Settings tab, you can use the rule template or create a custom rule. To use the template, set the following parameters and click Next to continue.

   • Monitoring Targets. Select at lease a node in your cluster for monitoring.
   • Alerting Rule. Define a rule for the alerting policy. The rules provided in the drop-down list are based on Prometheus expressions and an alert will be triggered when conditions are met. You can monitor objects such as CPU, and memory.

   Note

   You can create a custom rule with PromQL by entering an expression in the Monitoring Metrics field (autocompletion supported). For more information, see Querying Prometheus.

5. On the Message Settings tab, enter the summary and details of the alerting message, then click Create.

6. An alerting policy will be Inactive when just created. If conditions in the rule expression are met, it will reach Pending first, and then turn to Firing if conditions keep to be met in the given time range.

Edit an Alerting Policy

To edit an alerting policy after it is created, on the Alerting Policies page, click on the right of the alerting policy.

1. Click Edit from the drop-down list and edit the alerting policy following the same steps as you create it. Click OK on the Message Settings page to save it.

2. Click Delete from the drop-down list to delete an alerting policy.

View an Alerting Policy

Click the name of an alerting policy on the Alerting Policies page to see its detail information, including the alerting rule and alerting history. You can also see the rule expression which is based on the template you use when creating the alerting policy.

Under Monitoring, the Alert Monitoring chart shows the actual usage or amount of resources over time. Alerting Message displays the customized message you set in notifications.

Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.