Trigger Alerts

Abnormal traffic patterns or errors in API usage can indicate problems or malicious attacks. Setting up alerting helps quickly detect such unusual activities. By setting up alerts for certain thresholds and activities, you can gain insights into patterns that might indicate a security breach, abuse, or abnormal usage.

Prerequisites

1. Obtain a user account with Super Admin or Runtime Admin role.
2. Publish a service.
3. Get the webhook of your notification system.

Add a Webhook Template

Each alert policy requires at least one webhook template for notifications. A webhook template defines the content and structure of data sent via webhook when an event occurs. Multiple policies can share the same webhook templates. Webhooks are a way for different applications or services to communicate with each other in real-time by sending HTTP requests to a predefined URL when certain events happen.

1. Select Alerts > Templates, then click Add Template.

2. Use Email-notice as template name, and your webhook URL as URL. This tutorial uses a webhook.site URL as an example.

3. In the Notification Template field (request body of the webhook), apply the following configurations. The Title, Severity and Detail fields come from the alert policy:

   hello, here is an alert example. 
   Title: {{ .Title }} 
   AlertTime: {{ .AlertTime.Format "2006 Jan 02 15:04:05" }} 
   Severity: {{.Severity}} 
   Detail: {{.Detail}}

4. Click Add.

Add an Alert Policy

An alert policy is a predefined set of conditions and rules that are configured to trigger specific actions or notifications when certain events or conditions occur. In this tutorial, you will set up an alert policy for gateway instance offline notification. The policy will call a webhook to notify relevant parties if a gateway instance goes offline within the last 10 minutes.

1. Select Alerts > Policies, then click Add Policy.
2. Enter the policy name. This example will use gateway-instance-offline as an example.
3. Click Add.
4. Click the newly created alert policy.
5. On Trigger Conditions, click Update.
6. Choose gateway instance offline as condition 1, then choose 5 minutes.
7. Click Update.
8. On Basics, click Update and then apply the following configurations:
   • Alert Title: API7 Gateway Instance Offline
   • Alert Detail: Please check the instance and recover immediately
9. Click Update.
10. On Webhook Notifications, click Enable to enable the Email-notice template.

Validate

Manually stop a gateway instance and you should see the following output:

hello, here is an alert example. 
Title: API7 Gateway Instance Offline 
AlertTime: 2006 Jan 02 15:04:05"
Severity: Medium 
Detail: Please check the instance and recover immediately