告警通知

异常流量的出现或频繁的 API 报错可能表明 API 本身存在问题，或遭到了恶意攻击。设置告警有助于快速检测此类异常活动。通过为某些关键指标和活动设置告警，你可以深入了解并及时识别安全漏洞、API 滥用或异常使用。

前提条件

1. 获取一个具有超级管理员 或 运行时管理员 角色的用户账户。
2. 发布一个服务，其中会包含至少一个 API。
3. 获取通知系统的 Webhook。

创建 Webhook 模板

每个告警策略至少需要一个用于通知的 Webhook 模板。 Webhook 模板定义事件发生时通过 Webhook 发送的数据的内容和结构。多个策略可以共享相同的 Webhook 模板。 Webhook 指不同应用程序或服务在发生某些事件时通过向预定义的 URL 发送 HTTP 请求来实时相互通信的一种方式。

1. 从左侧导航栏中选择告警 > Webhook 模板，然后单击新增模板。在对话框中，执行以下操作：

   • 在名称字段中，输入邮件通知。
   • 在 URL 字段中，输入 webhook URL。本教程使用 webhook.site URL 作为示例。
   • 在通知模板字段中（Webhook 的请求正文）中，应用以下配置。 Title、Severity 和 Detail 字段来自告警策略：

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

2. 单击新增。

设置告警策略

告警策略是一组预定义的条件和规则，用于在发生某些事件或条件时通过触发 Webhook 发送通知。 本节将举例介绍如何为网关实例离线通知配置告警策略。如果网关实例在过去 10 分钟内离线，该策略将调用 Webhook 通知相关人员。

1. 选择告警 > 策略，然后单击 新增告警策略。在对话框中，执行以下操作：

   • 选择告警策略的生效范围。
   • 输入策略名称。本示例将使用网关实例离线作为示例。
   • 单击新增。

2. 单击新创建的告警策略。

3. 在触发条件区域，单击更新。

4. 选择网关实例离线作为类型 1，然后选择 5 分钟。

5. 单击更新。

6. 在基本信息区域，单击更新。在对话框中，执行以下操作：

   • 告警标题：API7 网关实例离线
   • 告警详细信息：请检查网关实例运行状况并尽快修复。

7. 单击更新。

8. 在 Webhook 通知区域，单击开启，启用邮件通知模板。

验证

手动停止网关实例，你应该看到以下输出：

hello, here is an alert example. 
Title: API7 网关实例离线 
AlertTime: 2006 Jan 02 15:04:05"
Severity: Medium 
Detail: 请检查网关实例运行状况并尽快修复。