监控您的 API

本页面介绍如何使用 Cloud Endpoints 自动为您维护的日志和指标来监控您拥有的 API 的运行状况。当用户向您的 API 发出请求时,Endpoints 会记录请求和响应的相关信息。Endpoints 还会跟踪监控的四个黄金信号中的三个:延迟时间、流量和错误。这些使用情况和性能指标有助于监控 API。

准备工作

您必须部署您的 API 并向其发送请求,才能生成可供查看的日志和指标。如果您尚未执行任何设置,不妨试试从 Endpoints 快速入门开始。

API 概览

如果您要调试某个服务问题或者只是想确认一切正常运行,请转到 API 的概览:

  1. 在 Google Cloud Console 中,转到项目的 Endpoints > 服务页面:

    转到“Endpoints 服务”页面

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

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

图表

页面顶部会显示一些指标的图表,以便您立即发现任何峰值和低谷。您可以:

  • 使用第一个图表右上角的选择图表下拉列表显示您感兴趣的指标的图表,移除不需要的指标。此下拉列表中的每个条目都带有一个问号,将鼠标悬停在问号上即可查看该条目显示指标的相关说明。

  • 在概览的右上角,通过选择不同的时间范围来调整图形。此操作将调整这些图表中显示的值的时间范围,这会改变点的粒度。

方法表

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

  • 使用表格右上角的选择列下拉列表显示您感兴趣的指标,以及移除不需要显示的指标。此处的条目也带有问号,将鼠标悬停在问号上即可查看相关说明。

  • 使用概览右上角的时间范围选择器为表格中的指标值选择时间范围。此操作会为图表和表格选择一个时间范围。

日志

如果您在指标中发现了问题,请转到 Google Cloud Console 中的日志查看器页面,以查看您 API 的请求和响应的日志。

  • 如需查看 API 中单个方法的日志,请点击表格中的查看日志

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

  • 如需直接在“日志查看器”页面中查找 Endpoints 日志,请执行以下操作:

    1. 在 Cloud Console 中,转到 Stackdriver > Logging 页面。

      转到“日志查看器”页面

    2. 选择提供的 API (SERVICE_NAME),其中 SERVICE_NAME 是 Endpoints 服务的名称。

如需详细了解日志查看器中的日志结构,请参阅 Endpoints 日志参考

了解日志的其他作用:

  • 开始使用日志查看器
  • 使用日志查看器导出日志。这样,您就可以将日志流式传输到 BigQuery 以做进一步的分析,将原始日志保存到 Cloud Storage,或将其发送到 Pub/Sub 消息传递主题。
  • 使用高级日志过滤条件指定要查看的一组日志条目,例如获取延迟时间大于 300 毫秒的所有请求。

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

要查看特定使用方项目的指标,您的 API 使用方必须在发出请求时发送 API 密钥。由于 Endpoints 使用 API 密钥来识别与调用应用关联的项目,因此 API 使用方的 Google Cloud 项目中必须已经创建了 API 密钥。要了解如何使用 API 密钥限制对 API 的访问,请参阅使用 API 密钥限制 API 访问权限

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

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

  2. 在 Cloud Console 中,转到项目的 Endpoints > 服务页面。

    转到“Endpoints 服务”页面

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

  4. 点击过滤

页面上的指标会更新,以反映仅来自指定项目的流量。

提醒

Cloud Monitoring 还提供了由 Endpoints 收集的指标。您可以使用 Monitoring 设置关于延迟时间、流量和错误的提醒。使用 Endpoints 指标,唯一不能设置提醒的黄金信号是饱和度。监控饱和度所需的指标取决于您的应用。如需了解针对饱和度设置提醒时可使用的指标,请参阅 Cloud Monitoring 中提供的指标列表。

要设置提醒,请执行以下操作:

  1. 如果您的项目还没有工作区,请创建工作区。确保受 Endpoints 监控的 API 所属的项目 ID 与该帐号相关联。

  2. 使用以下信息创建提醒政策,以便针对黄金信号设置提醒:

    • 延迟时间

      1. 对于条件类型,请输入 Metric Threshold
      2. 对于资源类型,请输入 Produced API
      3. 对于指标,请输入 Request latencies
      4. 输入要发出提醒的阈值,然后按照提醒指南中的其余说明进行操作。
    • 流量

      1. 对于条件类型,请输入 Metric Threshold
      2. 对于资源类型,请输入 Produced API
      3. 对于指标,请输入 Request count
      4. 输入要发出提醒的阈值,然后按照提醒指南中的其余说明进行操作。
    • 错误

      1. 对于条件类型,请输入 Metric Threshold
      2. 对于资源类型,请输入 Produced API
      3. 对于指标,请输入 Request count
      4. 对于响应代码类,请输入 5xx
      5. 输入要发出提醒的阈值,然后按照提醒指南中的其余说明进行操作。

后续步骤