第 19 章 指定方法并添加用于捕获使用详情的指标

应用程序计划为消费者访问 API 设置限制和定价规则。要启用限制和规则的执行，请在 API 中指定方法，用于收集单个使用量数据或添加指标。为每个指定方法和每个自定义指标添加一个映射规则。映射规则指定要捕获的使用情况数据的详情。

您可以为产品和后端指定方法或添加指标。对于产品，这能够在产品的应用计划中设定限制和定价规则。对于后端，这会为捆绑该后端的任何产品在应用程序计划中设置限制和定价规则。

指定捕获单个调用数量的方法。这为跟踪 API 的使用提供了更精细的粒度。向方法报告流量会自动增加方法和 Hits 指标的计数器。您可以为 API 后端的每个端点指定方法，或者端点和 HTTP 方法的组合。请参阅 Adding map 规则到方法和指标，以了解如何将 API 的端点映射到此处添加的方法。

指标可用于跟踪产品和后端的 API 使用情况。hits 是每个 API 存在的内置指标。它跟踪对您的 API 的调用数量。要捕获 Hits 之外的 API 的使用，请定义一个以不同单位报告使用的指标。单元应该可扩展，并对您的业务目标（如兆字节、CPU 时间或 API 返回的元素数量）具有意义。默认不提供 Hits 以外的指标，如 CPU 时间或 mb。使用由用户配置的外部服务调用的端点来获取这些指标。

方法和指标是打包 API 的构建。通过每个应用程序计划，您可以为每个指定方法和每个指标定义不同的使用限值和定价规则。请参阅 API 分析，以了解更多有关指标和方法报告的使用情况的信息。

19.1. 在产品和后端中添加方法

向产品或后端添加方法意味着您要在 API 中指定您想要捕获各个使用详情的方法。应用计划为您提供了为您添加到产品或后端的每种方法设置限制的功能。将方法或指标添加到产品的过程类似于向后端添加方法或指标。

流程

  1. 导航到 [Your_product_name] > Integration > Methods & Metrics 或 [Your_backend_name] > Methods & Metrics。
  2. 单击 New method。

  3. 在 Friendly name 字段中，输入方法的简短描述。此名称显示在 3scale 管理门户的不同部分中。对产品而言，友好名称必须是唯一的。

    重要

    在更改方法的系统名称或删除它们时，请小心。如果有指向方法先前系统名称的映射规则，这些更改可能会破坏您已部署的 3scale 集成。

  4. 在 System name 字段中，在 API 中输入方法名称，以用于通过 3scale Service Management API 报告使用情况。系统名称必须符合这些规则：

    • 产品或后端中的唯一
    • 仅包含字母数字字符、下划线 _、连字符 - 或正斜杠 /
    • 无空格

    否则，您可以自由决定系统名称的样子。它可以和端点(/status)相同，或者可以包含方法和路径(GET_/status)。

  5. 可选：在 Description 字段中，输入方法的更详细描述。
  6. 单击 Create Method。

验证步骤

  • 添加的方法在应用计划中可用。

后续步骤

  • 进入 [Your_product_name] > Applications > Application Plans > [plan_you_want_to_edit] 来编辑每种方法的限制和定价规则。