API 管理监视数据参考

适用于：所有 API 管理层级

本文包含此服务的所有监视参考信息。

有关可为 Azure API 管理收集的数据以及如何使用它的详细信息，请参阅 Monitor API 管理。

指标

本部分列出了为此服务自动收集的所有平台指标。 这些指标也是 Azure Monitor 中支持的所有平台指标的全局列表的一部分。

有关指标保留的信息，请参阅 Azure Monitor 指标概述。

Microsoft.ApiManagement/service 受支持的指标

下表列出了可用于 Microsoft.ApiManagement/service 资源类型的指标。

注释

事件中心事件指标当前不适用于 API 管理 v2 层。

• 并非所有列都显示在每个表中。
• 某些列可能超出了页面的查看区域。 选择“展开表”以查看所有可用列。

表标题

• 类别 - 指标组或分类。
• 指标 - 在 Azure 门户中显示的指标显示名称。
• REST API 中的名称 - 在 REST API 中引用的指标名称。
• 单位 - 度量单位。
• 聚合 - 默认的聚合类型。 有效值：平均值（平均）、最小值（最小值）、最大值（最大值）、总计（总和）、计数。
• 维度 - 适用于指标的维度。
• 时间粒度 - 对指标采样的间隔。 例如，PT1M 表示该指标每分钟采样一次，PT30M 表示每 30 分钟一次，PT1H 表示每小时一次，以此类推。
• DS 导出 - 是否可通过诊断设置将指标导出到 Azure Monitor 日志。 要了解如何导出指标的信息，请参阅在 Azure Monitor 中创建诊断设置。

类别：容量

指标	REST API 中的名称	高级平台指标	单位	聚合	维度	时间粒度	DS 导出
容量 ApiManagement 服务的利用率指标。 注意：对于除“高级”以外的 SKU，“最大值”聚合将该值显示为 0。	Capacity	否	百分比	平均值、最大值	Location	PT1M	是
网关的 CPU 百分比 SKUv2 服务的网关 CPU 百分比	CpuPercent_Gateway	否	百分比	平均值、最大值	<无>	PT1M	是
网关的内存百分比 SKUv2 服务的网关内存百分比	MemoryPercent_Gateway	否	百分比	平均值、最大值	<无>	PT1M	是

类别：EventHub 事件

指标	REST API 中的名称	高级平台指标	单位	聚合	维度	时间粒度	DS 导出
删除的事件中心事件数 由于达到队列大小限制而跳过的事件数	EventHubDroppedEvents	否	计数	总计（总和）	Location	PT1M	是
拒绝的事件中心事件数 拒绝的事件中心事件（配置不当或未授权）数	EventHubRejectedEvents	否	计数	总计（总和）	Location	PT1M	是
成功的事件中心事件数 成功的事件中心事件数	EventHubSuccessfulEvents	否	计数	总计（总和）	Location	PT1M	是
限制的事件中心事件数 限制的事件中心事件数	EventHubThrottledEvents	否	计数	总计（总和）	Location	PT1M	是
超时的事件中心事件数 超时的事件中心事件数	EventHubTimedoutEvents	否	计数	总计（总和）	Location	PT1M	是
事件中心事件大小 事件中心事件的总大小，以字节为单位	EventHubTotalBytesSent	否	字节	总计（总和）	Location	PT1M	是
事件中心事件总数 发送到事件中心的事件数	EventHubTotalEvents	否	计数	总计（总和）	Location	PT1M	是
失败的事件中心事件数 失败的事件中心事件数	EventHubTotalFailedEvents	否	计数	总计（总和）	Location	PT1M	是

类别：网关请求

指标	REST API 中的名称	高级平台指标	单位	聚合	维度	时间粒度	DS 导出
后端请求持续时间 后端请求持续时间（毫秒）	BackendDuration	否	毫秒	平均值、最大值、最小值	Location、 Hostname、、 ApiId	PT1M	是
网关请求的总持续时间 网关请求的总持续时间，以毫秒为单位	Duration	否	毫秒	平均值、最大值、最小值	Location、 Hostname、、 ApiId	PT1M	是
失败的网关请求数（已弃用） 网关请求失败数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标	FailedRequests	否	计数	总计（总和）	Location、Hostname	PT1M	是
其他网关请求数（已弃用） 其他网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标	OtherRequests	否	计数	总计（总和）	Location、Hostname	PT1M	是
请求 包含多个维度的网关请求指标	Requests	否	计数	总计（总和）、最大值、最小值	Location、、HostnameLastErrorReason、BackendResponseCode、GatewayResponseCode、BackendResponseCodeCategory、、 GatewayResponseCodeCategoryApiId	PT1M	是
成功的网关请求数（已弃用） 成功的网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标	SuccessfulRequests	否	计数	总计（总和）	Location、Hostname	PT1M	是
网关请求总数（已弃用） 网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标	TotalRequests	否	计数	总计（总和）	Location、Hostname	PT1M	是
未经授权的网关请求数（已弃用） 未经授权的网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标	UnauthorizedRequests	否	计数	总计（总和）	Location、Hostname	PT1M	是

类别：网关 WebSocket

指标	REST API 中的名称	高级平台指标	单位	聚合	维度	时间粒度	DS 导出
WebSocket 连接尝试(预览) 基于所选源和目标进行 WebSocket 连接尝试的计数	ConnectionAttempts	否	计数	总计（总和）、平均值	Location、、SourceDestination、、State	PT1M	是
WebSocket 消息(预览) 基于所选源和目标的 WebSocket 消息计数	WebSocketMessages	否	计数	总计（总和）、平均值	Location、 Source、、 Destination	PT1M	是

类别：网络状态

指标	REST API 中的名称	高级平台指标	单位	聚合	维度	时间粒度	DS 导出
资源的网络连接状态（预览） API 管理服务中从属资源类型的网络连接状态	NetworkConnectivity	否	计数	总计（总和）、平均值	Location、ResourceType	PT1M	是

指标维度

有关指标维度定义的信息，请参阅多维指标。

此服务具有以下与其指标关联的维度。

• ApiId
• 后端响应代码
• BackendResponseCodeCategory
• 目标
• GatewayResponseCode
• GatewayResponseCodeCategory
• 主机名
• LastErrorReason
• 位置
• 资源类型
• 来源
• 国家

Microsoft.ApiManagement/gateways 支持的指标

下表列出了可用于 Microsoft.ApiManagement/gateways 资源类型的指标。

表标题

指标 - 在 Azure 门户中显示的指标显示名称。 Rest API 中的名称 - 在 REST API 中引用的指标名称。 单位 - 度量单位。 聚合 - 默认的聚合类型。 有效值：平均值、最小值、最大值、总计、计数。 维度 - 适用于指标的维度。 时间粒度 - 对指标采样的间隔。 例如，PT1M 表示该指标每分钟采样一次，PT30M 表示每 30 分钟一次，PT1H 表示每小时一次，以此类推。 DS 导出 - 是否可通过诊断设置将指标导出到 Azure Monitor 日志。

有关导出指标的信息，请参阅 - 使用数据收集规则 导出指标并在 Azure Monitor 中创建诊断设置。

有关指标保留的信息，请参阅 Azure Monitor 指标概述。

类别：利用率

指标	REST API 中的名称	高级平台指标	单位	聚合	维度	时间粒度	DS 导出
CPU 使用率（%） API 网关的所有核心的处理器总使用率。	CpuPercent_Gateway	否	百分比	平均值、最大值	<无>	PT1M	是
内存利用率（%） API 网关中活动进程使用的物理内存百分比。	MemoryPercent_Gateway	否	百分比	平均值、最大值	<无>	PT1M	是

资源日志

本部分列出了可为此服务收集的资源日志类型。 本部分拉取自 Azure Monitor 支持的所有资源日志类别类型列表。

Microsoft.ApiManagement/service 支持的资源日志

类别	导出成本	日志表	支持基本日志计划	支持引入时间转换	示例查询
DeveloperPortalAuditLogs	是	APIM开发门户审核诊断日志 API Management 开发人员门户 API 的诊断日志。	是	是
GatewayLlmLogs	是	ApiManagementGatewayLlmLog 与 API 管理语言的语言模型相关的网关日志。	是	是
GatewayLogs	否	ApiManagementGatewayLogs Azure ApiManagement 网关日志。	是	是	查询
GatewayMCPLogs	是	ApiManagementGatewayMCPLog 与 MCP 请求相关的网关日志。	是	否
WebSocketConnectionLogs	是	ApiManagementWebSocketConnectionLogs Websocket 连接日志提供 API 管理网关的 Websocket 连接事件日志。 当请求到达 API 管理网关进行握手时，日志记录开始，直到请求终止。 每个请求日志都可以用 CorrelationId 唯一标识。	是	否

Microsoft.ApiManagement/service/workspaces 支持的资源日志

类别	导出成本	日志表	支持基本日志计划	支持引入时间转换	示例查询
GatewayLogs	是	AzureDiagnostics 来自多个 Azure 资源的日志。	否	否

Azure Monitor 日志表

本部分列出了与此服务相关的 Azure Monitor 日志表，日志分析可使用 Kusto 查询来查询这些表。 这些表包含资源日志数据，此外还可能包含其他数据，具体取决于所收集并路由到这些表的内容。

API 管理 Microsoft.ApiManagement/service

• APIM开发门户审核诊断日志
• AzureActivity
• AzureMetrics
• AzureDiagnostics
• ApiManagementGatewayLogs
• ApiManagementWebSocketConnectionLogs

活动日志

链接表列出了可在此服务的活动日志中记录的操作。 这些操作是活动日志中所有可能的资源提供程序操作的子集。

有关活动日志条目架构的详细信息，请参阅活动日志架构。

• Microsoft.ApiManagement 资源提供程序作

相关内容

• 有关监视 Azure API 管理的说明，请参阅 Monitor API 管理。
• 请参阅使用 Azure Monitor 监视 Azure 资源，详细了解如何监视 Azure 资源。