Alerting Policies (Workload Level)

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

Prerequisites

• You have enabled KubeSphere Alerting.
• To receive alert notifications, you must configure a notification channel beforehand.
• You need to create a workspace, a project and a user (project-regular). The user must be invited to the project with the role of operator. For more information, see Create Workspaces, Projects, Users and Roles.
• You have workloads in this project. 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 project-regular and go to your project. Go to Alerting Policies under Monitoring & Alerting, then click Create.

2. 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 alert-demo.
   • Alias. Help you distinguish alerting policies better.
   • Description. A brief introduction to the alerting policy.
   • 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.

3. On the Rule Settings tab, you can use the rule template or create a custom rule. To use the template, fill in the following fields.

   • Resource Type. Select the resource type you want to monitor, such as Deployment, StatefulSet, and DaemonSet.
   • Monitoring Targets. Depending on the resource type you select, the target can be different. You cannot see any target if you do not have any workload in the project.
   • Alerting Rule. Define a rule for the alerting policy. These rules 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.

   Click Next to continue.

4. On the Message Settings tab, enter the alert summary and message to be included in your notification, then click Create.

5. An alerting policy will be Inactive when just created. If conditions in the rule expression are met, it reaches Pending first, 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.

1. Click Edit from the drop-down menu 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 menu to delete an alerting policy.

View an Alerting Policy

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

Under Alert 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.