Alarm Policies

Create Alarm Policy

It is recommended to set up notifications for relevant personnel in case of any exceptions occurring in the API7 Enterprise or the APIs. This will facilitate a quick response to any potential issues.

• You need to install several components: Prometheus, AlertManager, and OpenSearch.
• Create alarm notification templates before creating alarm policy.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. If the object to be monitored for alarms is the entire cluster (all APIs and data plane nodes within the cluster), click on Alarm then click on Alarm Policies in the left menu bar and skip steps 6~8.
6. In the left menu bar, click on Workspaces .
7. Click on View button of the specific workspace.
8. In the left menu bar, click on Alarm then click on Alarm Policies .
9. Click on Create button.
10. Fill in the form.
11. Click on Submit button.

caution

If the alarm policy is not configured with an alarm notification template, only the triggering records can be seen in the alarm history, and notifications cannot be received in a timely manner.

Configure Alarm Strategy

Modify the attributes of the alarm policy.

After successful configuration, it will not take effect until the next alarm check cycle. The ongoing alarm tasks will not be interrupted by the modification.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. If the object to be monitored for alarms is the entire cluster (all APIs and data plane nodes within the cluster), click on Alarm then click on Alarm Policies in the left menu bar and skip steps 6~8.
6. In the left menu bar, click on Workspaces .
7. Click on View button of the specific workspace.
8. In the left menu bar, click on Alarm then click on Alarm Policies .
9. Click on Configure button corresponding to the alarm policy.
10. Edit the attributes of the alarm policy.
11. Click on Submit button.

Delete Alert Policy

Permanently stop the alert policy and delete the records.

Alert policies with the status "Enabled" and "Paused" can be deleted.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. If you need to monitor the entire cluster (all APIs within the cluster and data plane nodes), click on Alarm then click on Alarm Policies in the left menu bar and skip steps 6-8.
6. In the left menu bar, click on Workspaces .
7. Click on View button of the specific workspace.
8. In the left menu bar, click on Alarm then click on Alarm Policies .
9. Click on the Delete button of the corresponding alert policy.
10. Click on the OK button.

Pause Alert Policy

Pause alerts but keep the alert policy record.

• Only alert policies with the status "Enabled" can be paused.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. If you need to monitor the entire cluster (all APIs within the cluster and data plane nodes), click on Alarm then click on Alarm Policies in the left menu bar and skip steps 6-8.
6. In the left menu bar, click on Workspaces .
7. Click on View button of the specific workspace.
8. In the left menu bar, click on Alarm then click on Alarm Policies .
9. Turn off the Status switch of the corresponding alert policy.

Enable Alert Policy

Re-enable a paused alert policy.

• Only alert policies with the status "Disabled" can be paused.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. If you need to monitor the entire cluster (all APIs within the cluster and data plane nodes), click on Alarm then click on Alarm Policies in the left menu bar and skip steps 6-8.
6. In the left menu bar, click on Workspaces .
7. Click on View button of the specific workspace.
8. In the left menu bar, click on Alarm then click on Alarm Policies .
9. Turn on the Status switch of the corresponding alert policy to Enabled .