在 API Manager UI 中访问分析

如何从 API Manager UI 查看,分析和导出分析数据。

分析数据显示在 API Manager UI 中的仪表板中。 仪表板的作用域为提供者组织,目录和空间级别。

在目录或空间级别访问分析数据的能力取决于分配的角色和许可权。 有关目录和空间的更多信息,请参阅 Working with catalogsUsing syndication in API Connect

要访问目录范围分析仪表板,请完成以下步骤:
  1. API 管理器用户界面中,选择导航面板中的管理 "管理目录" 图标
  2. API Manager "仪表板" 中的可用目录列表中,选择所需的目录。
  3. 可选项: 如果启用了空间并希望查看空间范围内的分析结果,则
    1. 单击 空间 选项卡。
    2. 选择要查看的空间。
  4. 单击 " 分析 " 选项卡。分析目录视图

分析仪表板

API Manager UI 中的分析仪表板显示提供者组织,目录和空间范围内的 API 事件数据。

可通过导航面板上的分析图标 分析图标 访问医疗服务提供者组织范围内的仪表板。 分析目录视图

查看空间时,可从 分析 选项卡访问空间范围的仪表板。

以下仪表板可用:
  • 摘要: 有关调用卷,等待时间以及发生这些调用的时间的概览信息。
  • 使用情况: 云中的 API 调用总数。 对于基于使用的许可,此属性是必需的。
  • API: 您需要了解的有关调用哪些 API 以及哪些 API 未调用的所有信息。
  • 产品 : 哪些产品在总计和一段时间内都是最受欢迎的。
  • 使用者: 确定哪些使用者组织在一段时间内进行的 API 调用总数最多。
  • 应用程序: 哪些应用程序在总时间和一段时间内负责最多的 API 调用。
  • 人工智能使用情况:跟踪人工智能令牌数量和模型使用情况,了解人工智能服务的使用情况。
  • 状态 :关于 API 调用成功和失败的关键信息,显示一段时间内的成功率和失败率,以及 HTTP 响应代码明细。
  • 等待时间: API 返回响应所花费的时间以及随时间变化的等待时间。
  • 数据传输: 所有关于请求和响应有效内容的内容。 哪些 API、使用者和应用程序具有最大的请求和响应有效内容。
  • 客户机信息: 调用 API 的人员以及来自哪些设备的人员。
    注: 只能将因特网可访问的 IP 地址解析为地理位置。 将忽略内部 IP 地址。
  • 网关操作: 每个网关服务中每个网关的调用量和等待时间信息。 此信息可用于确定负载是均匀分布还是网关性能不佳。

仪表板中的每个图表都可以导出为 PNG 或 JPG 图像。 每个图表的源数据可以导出为 JSON 或 CSV 文件。 要导出图表,请单击右上角的操作分析示例饼图

也可以通过点击 分析全屏图标 将图表放大到全屏。 要查看表格形式的源数据,请单击 分析表图标

发现视图

缺省情况下,将显示 仪表板 选项卡。 要以表格形式查看 API 事件数据,请选择 发现:

分析发现视图可从用户界面访问的 API 事件最多为 10,000 个。 " 发现 " 视图上每页可显示的最大事件记录数为 200。

您可以定制 过滤器 部分中显示的列。 您可以通过点击列标题,按升序或降序对表格进行排序。

您可以将时间线图表切换为对数 y 轴,并通过单击图表右上角的 操作 来导出图表的数据:

导出图表数据和切换时间线菜单

您可以通过单击表右上方的 操作 从表中导出 API 事件数据:

分析数据导出菜单选项

注意: 选择 " 导出为 CSV "或 " 导出为 JSON "从 "发现 "视图导出时,只导出当前结果页面上显示的数据。 要从所有页面导出数据,请选择完整数据为 CSV完整数据为 JSON。 您还可以使用工具包 CLI 导出所有分析数据。 更多信息,请参阅导出分析数据

如果在 "发现 " 视图中看到意外的 HTTP OPTIONS 事件,这些事件是由于基于浏览器的 API 测试工具发出 CORS 请求所致。 有关测试工具和 OPTIONS 调用的更多信息,请参阅 测试 API

过滤显示的数据

您可以通过定义过滤器 (也称为 查询) 来过滤 " 仪表板 " 和 " 发现 " 视图中显示的数据。 展开 过滤器 部分以查看,定义和应用对所显示数据的查询:

分析过滤器设置

您可以保存和共享定义的查询:
  • 共享查询对同一作用域中的所有用户可见。 它们对于其他作用域中的用户不可见。 例如, Cloud Manager UI 用户共享的查询对于 API Manager UI 用户不可见。 在 API Manager UI 中,在目录作用域中创建的查询对于在提供者组织作用域中查看分析数据的用户不可见。
  • 其他用户无法编辑或删除您共享的查询,但他们可以创建重复的查询,他们可以编辑和共享该查询。
  • 所有查询都具有名称和可选描述。 该名称不需要唯一。

可以将已保存的查询导出为字符串,以便在 REST API 和 工具箱 CLI 查询中使用,例如:

分析复制查询菜单选项将以下字符串复制到剪贴板:
timeframe=last7days

在分析中设置默认查询

现在您可以设置默认查询,当您访问 Analytics 中的 "仪表板 "或 "发现 "页面时会自动应用该查询。 默认查询是按用户和范围(组织、目录或空间)配置的。
注:
  • 只能将共享查询设置为默认查询。
  • 每个作用域可以为每个用户设置一个默认查询。 可以为每个目录和空间设置不同的默认查询。
  1. 确保要设置为默认值的查询已保存。
  2. 要共享已保存的查询,请完成以下步骤。
    • 单击保存选项卡。
    • 从选项菜单中单击 " 共享 "。
    • 共享查询窗口中,单击共享
  3. 单击共享选项卡。
  4. 从选项菜单中,单击设置为默认查询Editanalytics_copy_query.png
  5. 在 " 默认查询 " 窗口中,单击 " 默认 "。
  6. 要立即应用默认查询。 单击应用。 默认查询会立即应用于该范围内的所有用户。 如果在设置默认查询后不单击 " 应用 ",则会在下次访问 "仪表板 ""发现 " 选项卡时自动应用。

"报告" 视图

报告视图显示的是长期汇总数据,而不是单个 API 事件。分析报告视图
注: 报告 视图是在 v10.0.6中引入的,不包括在升级到 v10.0.6之前生成的数据。

调用量趋势显示最活跃和最不活跃的 API、成功和失败的 API 调用总数、发送和接收的总字节数以及基于范围的总数。分析调用量趋势磁贴

消费者趋势显示消费者数量以及订阅和申请数量的变化情况: 分析消费者趋势磁贴

消费报告显示了网关处理的 API 调用的长期趋势,这对基于消费的许可洞察至关重要。消费报告

不活跃产品显示没有订阅的产品和没有流量的产品。分析不活动产品磁贴

不活动消费者组织显示没有应用程序、订阅、最近流量或根本没有流量的消费者组织。分析不活动使用者组织磁贴

已废弃产品显示已废弃但仍有流量的产品。不推荐的产品报告

API 调用量排行榜部分显示了 API、产品、计划、应用、消费者组织、网关服务和按目录细分的排行榜。 点击名称一栏 ,查看每个项目的数据。分析调用卷排行榜表