告警通知
API 使用中的异常流量模式或错误可能表明存在问题或恶意攻击。为特定阈值和活动设置告警,可以帮助你快速发现可能表明安全漏洞、滥用或异常使用的模式。
本教程介绍如何设置告警策略,在网关实例离线时发出通知。如果网关实例在过去 10 分钟内离线,告警策略会调用 Webhook 通知相关人员。
前提条件
- 安装 API7 企业版。
- 确保网关组中有一个正在运行的 API。
- 获取通知系统的 Webhook URL。
创建 Webhook 模板
每个告警策略至少需要一个发送通知的 Webhook 模板。Webhook 模板定义事件发生时通过 Webhook 发送的数据内容和结构。多个策略可以共用同一个模板。
Webhook 让不同应用或服务能够实时通信。特定事件发生时,Webhook 会向预定义的 URL 发送 HTTP 请求。
-
在侧边栏选择 告警,然后点击 Webhook 模板。
-
点击 新增模板。
-
将模板名称设为
Email-notice,并填写你的 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}} -
点击 新增。
设置告警策略
告警策略是一组预定义的条件和规则,在特定事件或条件出现时触发相应操作或通知。
-
在侧边栏选择 告警,然后点击 策略。
-
点击 新增告警策略。
-
输入策略名称。本教程以
gateway-instance-offline为例。 -
点击 新增。
-
点击新创建的告警策略。
-
在 触发条件 区域点击 更新。
-
将条件 1 设置为 网关实例离线,然后选择
5 分钟。 -
点击 更新。
-
在 基本信息 区域点击 更新,然后填写以下内容。
- 告警标题填写
API7 Gateway Instance Offline。 - 告警详细信息填写
Please check the instance and recover it immediately。
- 告警标题填写
-
点击 更新。
-
在 Webhook 通知 区域,点击 开启,以启用
Email-notice模板。
验证
手动停止一个网关实例,你应看到以下输出。
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