第 31 章 实施 3scale API 分析以管理和优化 API 访问

通过实施 3scale API 分析来管理和优化 API 访问，您可以跟踪一段时间内的使用量趋势等项目。了解如何使用您的 API 是管理流量、配置峰值和识别向 API 发送最多请求的用户的关键步骤。

3scale 收集您可以在以下级别上定义的方法和指标的 API 分析：

  • 产品 ：Hits 是跟踪到 API 流量的内置指标。您可以在 API 中创建附加指标和指定方法以捕获分析。
  • 后端：3scale 将方法和指标注册到后端，就如同使用 API 后端从属于每个产品一样。您可以在产品级别上为应用程序计划中的后端指标设置限值和定价规则。
  • 应用程序：您可以获取在 3scale 中创建的每个应用程序的分析报告。

先决条件

  • 您完成了入门说明。

    通过使用 入门 指南，您可以使用现有的 3scale 代码插件之一来执行集成。

  • 或者，按照与其他集成方法类似的流程进行操作。请参阅文档中的操作 APIcast 章节，以了解更多有关可用的集成选项的信息。

31.1. 3scale API 指标和方法捕获 API 的使用

3scale 充当您的 API 产品统计的无限可扩展数据存储库。您可以使用指标和方法捕获 API 产品统计信息，以便您可以获得优化管理对 API 的访问所需的信息。例如：

  • Hits/transactions: 对 API 产品的调用。默认情况下，点击作为所有 API 的指标包括。命中可以是对 API 产品的整体调用，也可以划分成 API 产品的不同方法。
  • 数据传输：通过 API 产品上传和下载的 MB/GB 数据数量
  • CPU 小时 ：与 API 产品调用相关的计算时间（或某些其他内部资源）
  • 返回的结果：返回的记录或数据对象的数量
  • 磁盘存储 ：帐户使用的总磁盘存储

您可以跟踪与 API 产品相关的更多指标。3scale 可以跟踪任意数量的指标和方法，只要它是可随着时间递增的可数。

选择了要使用的指标后，请使用将指标 添加到产品和后端中所述的步骤在管理门户中注册。

您可以将指标和方法添加到您选择的产品或后端。为他们提供友好的名称和系统名称，3scale 在插件配置中使用。有关创建方法和指标的详情，请参阅指定 方法和添加用于捕获使用详情的指标。