通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

获取 Azure API 管理中的 API 分析

  • 项目

适用范围：开发人员 | 基本 | 基本 v2 | 标准 | 标准 v2 | 高级 | 高级 v2

Azure API 管理为 API 提供分析，以便你能够分析其使用情况和性能。 使用分析功能对 API 进行高级别监视和故障排除。 有关其他监视功能（包括用于诊断和审核的准实时指标和资源日志），请参阅教程：监视已发布的 API。

门户中 API 分析的屏幕截图。

注意

目前无法在工作区中使用此功能。

关于 API 分析

  • API 管理使用基于 Azure Monitor 的仪表板提供分析。 该仪表板将 Azure Log Analytics 工作区中的数据聚合在一起。

  • 在经典 API 管理服务层级中，API 管理实例还包括 Azure 门户中旧的内置分析，可以使用 API 管理 REST API 访问分析数据。 基于 Azure Monitor 的仪表板和内置分析中显示了非常相似的数据。

重要

  • 推荐使用基于 Azure Monitor 的仪表板来访问分析数据。
  • 内置（经典）分析在 v2 层中不可用。

使用 API 分析，跨多个维度分析 API 管理实例中 API 的使用情况和性能，其中包括：

  • 时间
  • 地理位置
  • API
  • API 操作
  • 产品
  • 订阅
  • 用户
  • 请求

注意

  • API 分析提供有关请求（包括失败的请求和未经授权的请求）的数据。
  • 地理值是基于 IP 地址映射的近似值。
  • 分析数据的可用性可能存在延迟。

基于 Azure Monitor 的仪表板

若要使用基于 Azure Monitor 的仪表板，需要 Log Analytics 工作区作为 API 管理网关日志的数据源。

如果需要配置一个，请按照下面的简短步骤将网关日志发送到 Log Analytics 工作区。 有关详细信息，请参阅教程：监视已发布的 API。 这是一次性设置。

  1. 在 Azure 门户，导航到 API 管理实例。
  2. 在左侧菜单中的“监视”下，选择“诊断设置”>“+ 添加诊断设置”。
  3. 为诊断设置输入一个描述性名称。
  4. 在“日志”中，选择“与 ApiManagement 网关相关的日志”。
  5. 在“目标详细信息”中，选择“发送到 Log Analytics”，然后在相同或不同订阅中选择一个 Log Analytics 工作区。 如果需要创建工作区，请参阅创建 Log Analytics 工作区。
  6. 确保选择“特定于资源”作为目标表。
  7. 选择“保存”。

重要

新的 Log Analytics 工作区可能最多需要 2 小时才能开始接收数据。 现有工作区应在大约 15 分钟内开始接收数据。

访问仪表板

配置 Log Analytics 工作区后，访问基于 Azure Monitor 的仪表板来分析 API 的使用情况和性能。

  1. 在 Azure 门户，导航到 API 管理实例。
  2. 在左侧菜单的“监视”下，选择“分析”。 这会打开“分析”仪表板。
  3. 选择数据的时间范围。
  4. 选择分析数据的报告类别，例如“时间线”、“地理”，等等。

旧版内置分析

在某些 API 管理服务层中，内置分析（也称为旧分析或经典分析）也可以在 Microsoft Azure 门户中使用，并且可以使用 API 管理 REST API 访问分析数据。

内置分析 - 门户

若要在 Microsoft Azure 门户中访问内置（经典）分析，请执行以下操作：

  1. 在 Azure 门户，导航到 API 管理实例。
  2. 在左侧菜单中，在“监视”下，选择“分析(经典)”。
  3. 选择数据的时间范围，或者输入一个自定义时间范围。
  4. 选择分析数据的报告类别，例如“时间线”、“地理”，等等。
  5. （可选）按一个或多个其他类别筛选报表。

分析 - REST API

使用 API 管理 REST API 中的报告操作检索和筛选 API 管理实例的分析数据。

可用操作按 API、地理位置、API 操作、产品、请求、订阅、时间或用户返回报告记录。

相关内容