全部产品
Search
文档中心

API报警设置

更新时间: 2020-09-22

您可以通过云监控来对发布在API网关上的API配置报警,以便随时了解API服务运行情况,保障服务的稳定性。

1. 关联资源

API网关监控报警功能可以满足您多样化的业务需求,监控报警的指标包括:

  • HttpStatusCode

  • API响应时间

  • API总体请求次数

  • 流入流量

  • 流出流量

创建报警规则关联资源时,有三种方式,如下:

  • 手动关联同一Region下的一个API或者多个API。此方式适合对同Region下某一个或多个API设置相同的报警规则。API配置修改后,报警规则不受影响;

  • 关联API分组,也就是对一个API分组下的所有API设置相同的报警规则,监控这些API的调用情况。API分组下若需要对API进行增删改操作,会自动同步报警规则,无需额外修改;

  • 关联全部资源,指账号下的API网关产品中的所有API都作为关联资源,适用于需要管理的API很少的场景下。

说明

除关联全部资源方式,其他方式创建报警规则时可以选择具体环境(RELEASE、PRE、TEST)来配置API的监控报警。

2. 报警级别和方式

云监控报警可设置多级报警,阈值处于不同区间时,对应Critical 、Warning、Info三个不同级别,不同级别通过不同渠道发送报警通知。报警通知等详细配置可以参考概览

  • Critical:电话语音+手机短信+邮件+钉钉机器人(需付费使用)

  • Warning:手机短信+邮件+钉钉机器人

  • Info:邮件+钉钉机器人

报警规则

说明

阈值举例说明:如上图,含义是连续5分钟,其中每分钟的返回码2XX都超过200个,那么就会发送报警通知。

3. 设置一个或多个API的报警规则

配置过程中涉及的报警模板,报警规则,通知联系人,报警通知等详细配置可以参考概览

1、登录API网关控制台,选择地域,在API列表中找到想设置报警规则的API。

2、进入API管理页面,点击左侧菜单监控信息,之后点击页面右上角中的“报警设置”按钮,即进入到云监控配置控制台。

报警设置

3、在云监控配置控制台创建报警规则,资源范围选择API维度,API处您可以选择您需要关联的一个API或者多个API。

报警规则设置

4.设置API分组的报警规则

1、如果需要对该API分组下的所有API应用相同的报警规则,进入API分组详情页,点击详情页右上角的开启云监控

开启云监控

2、在第一次配置API分组云监控时,会有下面的弹出框提示用户创建API网关-云监控服务关联角色

关联角色

3、点击确定后,提示云监控开启成功,提示信息中会附有云监控的应用分组名称。云监控的这个应用分组是由API网关经用户授权后创建的,和当前的API分组对应,命名格式固定为:APIGATEWAY_${region}_${groupId},region的值是API分组所在的region,groupId是API分组的分组ID。

应用服务

4、成功开通云监控后,通过API分组详情页右上角的按钮点击跳转至云监控配置,即可直接配置应用到当前应用分组的报警规则。

配置云监控

5. 设置全部资源的报警规则

步骤与第3章相同,资源范围选择“全部资源”即可。设置完成后账号下API网关上的所有Region所有API都将使用同一报警规则,不能选择API,适用于需要管理的API很少的场景。

6. API网关支持的报警规则

API网关提供了HttpStatusCode,API响应时间,API总体请求次数,流入流量,流出流量 五个指标的规则;您可以就这几个方面,配置您的报警。

  • API响应时间:API网关的后端响应时间。

  • API总体请求次数:某一周期内API网关收到客户端的请求总次数。

  • 流入流量:某一周期内API网关收到的客户端请求产生的流量。

  • 流出流量:某一周期内API网关向后端服务发出请求产生的流量。

  • HttpStatusCode:API网关返回状态码,有Code2XX,Code4XX,Code5XX可选。

-Code2XX:表示API请求成功。(注意:此处并非一定是业务成功)

-Code4XX:表示客户端错误,可能是参数错误等。

-Code5XX:表示服务端错误,这个对于API开放者来说,一般需要重点监控。

6. 注意事项

  • 建议API分组在经典网络的用户使用标有旧版的报警规则,API分组在VPC网络的用户使用没有标记旧版的报警规则。

  • 可以根据API发布环境进行报警,如果VPC网络的用户根据环境配置报警无效,建议先打开API网关控制台,进入API详情页,在监控页面查看该API是否支持根据环境查询监控数据,如果不支持,请工单联系我们,我们将升级您的API网关版本。