监控您的 API

本页面介绍如何使用 API Gateway 自动为您维护的日志和指标来监控 API Gateway API 的运行状况。

创建 API 时，API Gateway 会自动创建相应的托管式服务。您可以在以下命令的输出中找到所创建的托管式服务的名称：

gcloud api-gateway apis describe API_ID

服务名称是 managedService 字段的值。

当用户向您的 API 发出请求时，API Gateway 会记录请求和响应的相关信息。API Gateway 还会跟踪监控的四个黄金信号中的三个：延迟时间、流量和错误。这些使用情况和性能指标有助于监控 API。

准备工作

如需生成日志和指标以供查看，请部署 API 并向其发送请求。如果您尚未创建 API 并将其部署到网关，请尝试使用 API Gateway 快速入门。

API 概览

如果您要调试某个服务问题或者只是想确认一切按预期运行，请转到 API 的概览：

  1. 在 Google Cloud 控制台中，依次前往 API Gateway > 您的项目的 API 页面：

    前往“API”

  2. 如果您有多个 API，请点击要监控的 API。

  3. 确保屏幕当前显示的是概览标签页。

图表

概览页面为某些指标提供了许多图表，以便您立即发现任何峰值、下降或意外活动。使用页面顶部的过滤器，您可以：

  • 使用选择图表下拉列表显示您感兴趣的指标的图表，以及移除不想要查看的指标。
  • 通过选择不同的时间范围来调整图形的范围。此操作将调整显示的值的时间范围，这会改变点的粒度。

方法表

做好进一步深入探究的准备后，请向下滚动至图表下方，您会看到一个表格，其中包含您的 API 中单个方法的指标。在此表格中，您可以执行以下操作：

  • 在表的左上角，点击过滤表图标，从下拉列表中选择优化的过滤查询选项。在每个过滤条件查询之间添加 OR 可搜索多个字词。
  • 在表的右上角，点击列显示选项图标可显示下拉列表。选中您感兴趣的指标，然后清除不需要显示的指标。
  • 使用概览页右上角的时间范围选择器为表格中的指标值选择时间范围。此操作会为图表和表格选择一个时间范围。

日志

如果您在指标中发现了问题，则可以使用 Google Cloud 控制台中的日志浏览器页面查看 API 的请求和响应的日志。

  • 要查看 API 中单个方法的日志，请点击表格中的查看日志。

  • 如需查看 API 中所有方法的日志，请点击右下角的查看所有日志。

  • 如需直接在“日志浏览器”页面中查找 API Gateway 日志，请执行以下操作：

    1. 在 Google Cloud 控制台中，进入日志浏览器页面：

      前往日志浏览器

    2. 选择 Products API (SERVICE_NAME)，其中 SERVICE_NAME 是代管式服务的名称。

如需详细了解日志浏览器中的日志结构，请参阅 API Gateway 日志参考。

了解日志的其他作用：

  • 开始使用日志浏览器。

    使用“查询”窗格指定要查看的一组日志条目，例如获取延迟时间大于 300 毫秒的所有请求。

  • 配置和管理接收器。这样，您就可以将日志流式传输到 BigQuery 以做进一步的分析，将原始日志保存到 Cloud Storage，或将其发送到 Pub/Sub 消息传递主题。

针对特定使用方项目进行过滤

要过滤特定使用方项目的指标，请执行以下操作：

  1. 获取 API 使用方项目的项目编号。如果您无权访问 API 使用方的项目，请要求具有相关权限的人员为您提供项目编号。

  2. 在 Google Cloud 控制台中，依次前往 API Gateway > 您的项目的 API 页面。

    前往“API”

  3. 在概览页面左上角的按项目编号过滤字段中输入项目编号。

  4. 点击过滤。

页面上的指标会更新，只显示来自指定项目的流量。

后续步骤