GraphQL 监控仪表板与日志记录（预览版）

项目
02/07/2025

注意

Fabric API for GraphQL 的监视仪表板和日志记录功能现为预览版。

在 Fabric 中为 GraphQL 部署 API 后，你可能想要了解客户端如何使用 API，并在 API 出现问题时排查错误。使用 Fabric GraphQL 监视仪表板来可视化、监控和排查 GraphQL API 请求活动中的问题。此功能目前以预览版提供。本文介绍如何有效地启用监视和使用仪表板的组件。

先决条件

已启用“工作区监视”。有关详细信息，请参阅 工作区监视概述 并按照步骤 启用工作区监视。
在开始使用监视和日志记录功能之前，必须在 Fabric 中使用 GraphQL API。有关详细信息，请参阅 在 Fabric 中创建 GraphQL API 并添加数据。

注意

监视功能会根据你的容量产生额外费用。
默认情况下禁用工作区监视。
活动监视的数据保留期限制为 30 天。

启用 GraphQL API 监视

在本部分中，我们将指导你完成为你的 GraphQL API 启用监视所需的步骤。默认情况下，此功能处于关闭状态。

要在租户中为每个 API for GraphQL 启用“指标”和/或“日志记录”体验，请打开 GraphQL API，然后选择“设置”图标：
在 API 设置窗口中，从左侧菜单中选择 监视（预览版） 选项。如果尚未启用工作区监视，你将看到一条说明，指导你转到“工作区设置”来启用它。
为工作区启用监视后，你将看到仅启用指标（API 仪表板）、日志记录（API 请求）或两者的选项。指标和日志将保存到 Kusto 中的单独表，可以根据要求单独启用每个功能。默认情况下，这两个选项均处于关闭状态：

备注

指标和日志记录数据单独发送到与工作区关联的 Kusto 数据库，因此会产生额外的费用。有关成本和消耗使用情况的详细信息，请参阅 工作区监视公告。

API 请求活动

启用监视后，GraphQL API 顶部功能区中的 API 请求活动 选项变为活动状态。选择它以访问监视详细信息。

顶部功能区中 API 请求活动选项卡的屏幕截图。

API 请求活动 由两个主要视图组成：

API 仪表板（适用于指标）：此页面显示指定时间范围的所有计数器和图形。
API 请求（用于日志记录）：此页面列出指定时间范围内的 API 请求。

在以下部分中，我们将介绍每个选项的功能。

指标（API 仪表板）

API 仪表板提供 API 活动的概述，其中包含各种指标和视觉对象。若要访问，请在 API 请求活动 页中选择 API 仪表板 选项卡。现在可以一目了然地查看特定时间范围的以下参数：

整体 GraphQL API 健康指数包括：
- API 请求/秒
- 成功率
- 健康状况
API 请求数
延迟
条形图中说明成功次数和错误的请求数

通过将鼠标悬停在图形上，可以查看工具提示中特定数据点的详细信息。

API 仪表板的屏幕截图。

指标主要功能：

时间范围选择：可以为监视图中显示的数据选择不同的时间范围。请注意，由于 工作区监视 限制，数据保留期仅适用于 30 天。
API 请求数/秒：可以查看所选时间范围内每秒发出的 API 请求数。
成功率：可以查看成功率，即所选时间范围内请求总数中成功的请求数。
基于每个 API 的成功率的总体 GraphQL API 运行状况索引：
- 绿色：75-100% 的请求成功（正常）
- 黄色：50-74% 的请求成功（需要注意）
- 红色：成功请求低于 50%（异常）
API 请求总数：可以查看所选时间范围内的 API 请求总数。
延迟折线图：通过将鼠标悬停在图形上，可以查看每个数据点的延迟和日期。
条形图 请求数，区分成功请求和错误：通过将鼠标悬停在关系图上，可以查看每个数据点的成功日期和时间和错误数。