Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS 中的监控工具

AWS 为您提供了各种可用于监控 API Gateway 的工具。您可以配置其中的一些工具来为您自动执行监控任务,但其他工具需要手动干预。建议您尽可能实现监控任务自动化。

AWS 中的自动监控工具

您可以使用以下自动化监控工具来监控 API Gateway 并在出现错误时进行报告:

  • Amazon CloudWatch 警报 – 按您指定的时间段观察单个指标,并根据相对于给定阈值的指标值在若干时间段内执行一项或多项操作。操作是发送通知到 Amazon Simple Notification Service (Amazon SNS) 主题或 Amazon EC2 Auto Scaling 策略。CloudWatch 警报将不会仅因为其处于特定状态而调用操作;该状态必须已改变并在指定的若干个时间段内保持不变。有关更多信息,请参阅使用 Amazon CloudWatch 监控 API 执行

  • Amazon CloudWatch Logs – 监控、存储和访问来自 AWS CloudTrail 或其他来源的日志文件。有关更多信息,请参阅 Amazon CloudWatch 用户指南 中的监视日志文件

  • Amazon CloudWatch Events – 匹配事件并将事件传送到一个或多个目标函数或流来进行更改、捕获状态信息和采取纠正措施。有关更多信息,请参阅 Amazon CloudWatch 用户指南 中的什么是 Amazon CloudWatch Events?

  • AWS CloudTrail 日志监控 – 在账户间共享日志文件,通过将 CloudTrail 日志文件发送到 CloudWatch Logs 对它们进行实时监控,使用 Java 编写日志处理应用程序,以及验证您的日志文件是否在由 CloudTrail 传送后未发生更改。有关更多信息,请参阅 AWS CloudTrail User Guide 中的使用 CloudTrail 日志文件

手动监控工具

监控 API Gateway 的另一个重要环节是手动监控 CloudWatch 警报未涵盖的项目。API Gateway、CloudWatch 和其他 AWS 控制台控制面板提供您的 AWS 环境状态的概览视图。建议您还要查看有关 API 执行的日志文件。

  • API Gateway 控制面板显示指定时间段内给定 API 阶段的以下统计数据:

    • API 调用

    • 缓存命中(仅当启用 API 缓存时)。

    • 缓存未命中(仅当启用 API 缓存时)。

    • 延迟

    • 集成延迟

    • 4XX 错误

    • 5XX 错误

  • CloudWatch 主页将显示以下内容:

    • 当前警报和状态

    • 警报和资源的图表

    • 服务运行状况

    此外,您还可以使用 CloudWatch 执行以下操作:

    • 创建自定义控制面板以监控您关心的服务

    • 绘制指标数据图,以排除问题并弄清楚趋势

    • 搜索并浏览您所有的 AWS 资源指标

    • 创建和编辑警报以接收有关问题的通知

创建 CloudWatch 警报以监控 API Gateway

您可以创建 CloudWatch 警报,用于在警报改变状态时发送 Amazon SNS 消息。警报会每隔一段时间 (由您指定) 监控一个指标,并根据相对于给定阈值的指标值每隔若干个时间段执行一项或多项操作。操作是向 Amazon SNS 主题或 Auto Scaling 策略发送的通知。警报仅在出现持续状态变化时才会调用操作。CloudWatch 警报将不会仅因为其处于特定状态而调用操作;该状态必须已改变并在指定的若干个时间段内保持不变。