亚马逊 API 网关监控

Amazon API Gateway允许您创建、配置和托管 RESTful API，以帮助移动应用程序和 Web 应用程序访问 AWS 服务。使用 Site24x7 的 AWS 集成，您不仅可以在 API 阶段级别而且在方法级别上监控 API 调用、缓存、延迟、服务器端和客户端错误的统计信息。

在阶段级别监视 API 执行
在方法级别监控 API 执行

在阶段级别监控 API 执行

先决条件

API Gateway 在 API 和阶段级别上自动向 CloudWatch 公开指标。要监控与资源关联的所有方法的 API 调用、延迟、集成延迟、400 和 500 错误，您需要启用详细的 CloudWatch 指标。

要启用详细的 CloudWatch 指标：

登录 AWS 管理控制台。转到 API Gateway 控制台。
选择 API。单击阶段。
在 API 的阶段列表中，选择阶段。
在阶段编辑器中选择日志。
要启用，请选择 CloudWatch 设置下的启用详细 CloudWatch 指标。
选择 保存更改。

设置和配置

如果您还没有这样做，请通过将 Site24x7 创建为 IAM 用户或在您的 AWS 账户和 Site24x7 的 AWS 账户之间创建跨账户 IAM 角色来启用对 AWS 资源的访问。了解更多。
接下来，在集成AWS 账户页面中，请确保选中 API Gateway Stage 列表旁边的复选框。了解更多。

策略和权限

请确保分配给 Site24x7 IAM 实体的策略文档中存在以下读取级别操作。了解更多。

"apigateway:GET"

轮询频率

默认情况下，API Gateway 指标数据点每 1 分钟发送一次到 CloudWatch。Site24x7 将每 1 分钟收集的数据汇总为 5 分钟的平均值。了解更多。

IT 自动化

您可以为 Site24x7 支持的 AWS 服务添加自动化。登录到 Site24x7 并转到管理 > IT 自动化模板 (+) > 添加自动化模板。添加自动化后，您可以计划它们一个接一个地执行。

您现在可以使用Amazon API Gateway 自动化自动调用 Amazon API Gateway 中的 API。

支持的指标

Site24x7 在 API 阶段级别收集以下指标。

指标	描述	数据类型	统计
4XX 错误	监测捕获的客户端错误的数量	计数	和
5XX 错误	监测捕获的服务器端错误的数量。	计数	和
缓存命中数	监测从 API 缓存服务的请求数。	计数	和
缓存未命中计数	监测启用缓存时后端服务的请求数。	计数	和
计数	监测 API 请求的总数	计数	和
集成延迟	监测 API 网关将请求路由到后端和从后端接收响应之间经过的时间。	毫秒	平均和第 95 个百分位
延迟	监测 API 网关从客户端接收到请求到向客户端返回响应之间经过的时间。	毫秒	平均和第 95 个百分位

查看数据

登录到 Site24x7 控制台。单击AWS。选择监控的 AWS 账户。
从菜单下拉菜单中选择API Gateway Stage 。
从监控的 API 阶段列表中，选择要查看其指标的阶段。
可以在 API Gateway 摘要选项卡中查看适用于您的资源的各种时间序列图（指标的可视化表示）。

在方法级别监控 API 执行

监控、可视化和提醒与资源路径相关的所有已定义方法的 API 执行指标，以解决 API 执行和实施中的问题。

先决条件

应启用 Amazon API Gateway 集成。
Site24x7 控制台中的 API Gateway 阶段监视器应该处于活动状态。
必须为 API 阶段启用详细的 CloudWatch 指标。

添加 API Gateway 资源监视器

本节介绍如何发现 API Gateway 资源并将其添加为监视器：

登录到 Site24x7 控制台。单击AWS。选择受监控的 AWS 账户。
从菜单下拉菜单中，选择API Gateway Resource。

发现

本节介绍如何从 API 阶段选择加入特定资源。

从下拉列表中选择一个 API 阶段（不能多选）
接下来，键入适当的正则表达式以匹配所选 API 阶段中的资源。将 .* 作为前缀或后缀附加到输入字符串以从 API 阶段选择特定资源。
例如，假设 API 阶段公开多个资源即。/收入，/用户，/费用。您可以输入 .*/income 以仅包含属于该特定路径的资源。
单击发现资源。

添加

与您的正则表达式模式匹配的所有资源及其方法将在下面列出。

单击要监视的资源的资源路径旁边的复选框
单击将选定的 Resource作为监视器添加到它们。

查看数据

登录到 Site24x7 控制台。
单击AWS。选择监控的 AWS 账户。
从菜单下拉列表中选择API Gateway 资源。
从监控的资源列表中，选择要查看其指标的资源。

元数据

API 概述

API 概览选项卡提供有关服务状态和配置的信息。

舞台属性

属性	描述
API 网关 ID	显示 API 标识符。
API 网关名称	显示 API 网关名称。
地区	显示 API 网关所在区域。

属性	描述
艺名	显示阶段的名称（调用 API 网关的 URI 中的第一个路径段）
创建日期	显示创建阶段时的时间戳。
上次更新时间	显示阶段上次更新时的时间戳。
部署 ID	显示阶段指向的部署标识符。
描述	显示阶段的描述。
缓存集群	显示是否为此阶段启用了缓存集群。
缓存集群大小	缓存集群的大小（如果启用）。
缓存集群状态	缓存集群的状态（如果已启用）。
文档版本	显示相关 API 文档的版本。
访问日志	显示记录访问的设置。
客户端证书 ID	显示 API 阶段的客户端证书标识符。
阶段变量	显示阶段变量。

方法设置

属性	描述
指标监控	指定是否启用 Amazon CloudWatch 指标。
日志记录级别	指定方法的日志记录级别（OFF、ERROR 或 INFO。
数据追踪	指定是否为此方法启用跟踪日志记录。
节流突发限制	指定限制突发限制。
节流速率限制	指定限制速率限制。
目标 ARN	显示接收访问日志的 CloudWatch 日志组的 ARN。
API 缓存	显示是否应缓存响应并返回请求。
缓存生存时间	以秒为单位显示缓存响应的生存时间 (TTL)。
缓存数据加密	显示缓存响应是否加密。
需要授权	显示缓存失效请求是否需要授权。
处理授权请求	显示如何处理未经授权的缓存失效请求。

金丝雀设置

属性	描述
金丝雀部署 ID	显示阶段指向的金丝雀部署的标识符。
流量百分比	显示转移到 Canary 部署的流量百分比。
金丝雀阶段变量	显示为金丝雀发布部署覆盖的阶段变量。
使用阶段缓存	指示金丝雀部署阶段是否使用阶段缓存。

资源设置

属性	描述
资源 ID	显示资源标识符。
编号	显示转移到 Canary 部署的流量百分比。
资源路径	显示资源的完整路径。
方法	显示方法的 HTTP 词汇。