閱讀英文

共用方式為

API 管理监视数据参考

适用于:所有 API 管理层级

Azure Monitor 从系统收集并聚合指标和日志,以监视可用性、性能和复原能力,并通知你影响系统的问题。 可以使用 Azure 门户、PowerShell、Azure CLI、REST API 或客户端库来设置和查看监视数据。

不同的指标和日志可用于不同的资源类型。 本文介绍可为此服务收集的监视数据类型以及分析这些数据的方法。

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

指标

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

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

Microsoft.ApiManagement/service 受支持的指标

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

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

表标题

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

后端请求持续时间(毫秒)
BackendDuration 毫秒 平均值、最大值、最小值 LocationHostnameApiId PT1M 是的
能力 容量

ApiManagement 服务的利用率指标。 注意:对于非“高级”的 SKU,“最大值”聚合会将数值显示为 0。
Capacity 百分比 平均值、最大值 Location PT1M 是的
网关 WebSocket WebSocket 连接尝试(预览)

基于所选源和目标的 WebSocket 连接尝试次数统计
ConnectionAttempts 计数 总计(总和)、平均值 LocationSourceDestinationState PT1M 是的
能力 网关的 CPU 百分比

SKUv2 服务的网关 CPU 百分比
CpuPercent_Gateway 百分比 平均值、最大值 <无> PT1M 是的
网关请求 网关请求的总持续时间

网关请求的总持续时间,以毫秒为单位
Duration 毫秒 平均值、最大值、最小值 LocationHostnameApiId PT1M 是的
EventHub 事件活动 丢失的EventHub事件

由于达到队列大小限制而跳过的事件数
EventHubDroppedEvents 计数 总计(总和) Location PT1M 是的
EventHub 事件活动 拒绝的事件中心事件数

被拒绝的 EventHub 事件(配置不当或未授权)数量
EventHubRejectedEvents 计数 总计(总和) Location PT1M 是的
EventHub 事件活动 成功的EventHub事件

事件中心成功事件数
EventHubSuccessfulEvents 计数 总计(总和) Location PT1M 是的
EventHub 事件活动 限制的事件中心事件数

限制的事件中心事件数
EventHubThrottledEvents 计数 总计(总和) Location PT1M 是的
EventHub 事件活动 超时的事件中心事件数

超时的事件中心事件数
EventHubTimedoutEvents 计数 总计(总和) Location PT1M 是的
EventHub 事件活动 事件中心事件大小

事件中心事件的总大小,以字节为单位
EventHubTotalBytesSent 字节 总计(总和) Location PT1M 是的
EventHub 事件活动 事件中心事件总数

发送到事件中心的事件数
EventHubTotalEvents 计数 总计(总和) Location PT1M 是的
EventHub 事件活动 失败的EventHub事件

事件中心失败事件的数量
EventHubTotalFailedEvents 计数 总计(总和) Location PT1M 是的
网关请求 失败的网关请求(已弃用)

网关请求失败数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标
FailedRequests 计数 总计(总和) LocationHostname PT1M 是的
能力 网关的内存百分比

SKUv2 服务的网关内存百分比
MemoryPercent_Gateway 百分比 平均值、最大值 <无> PT1M 是的
网络状态 资源的网络连接状态(预览)

API 管理服务中从属资源类型的网络连接状态
NetworkConnectivity 计数 总计(总和)、平均值 LocationResourceType PT1M 是的
网关请求 其他网关请求(已弃用)

其他网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标
OtherRequests 计数 总计(总和) LocationHostname PT1M 是的
网关请求 请求

包含多个维度的网关请求指标
Requests 计数 总计(总和)、最大值、最小值 LocationHostnameLastErrorReasonBackendResponseCodeGatewayResponseCodeBackendResponseCodeCategoryGatewayResponseCodeCategoryApiId PT1M 是的
网关请求 成功的网关请求数(已弃用)

成功的网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标
SuccessfulRequests 计数 总计(总和) LocationHostname PT1M 是的
网关请求 网关请求总数(已弃用)

网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标
TotalRequests 计数 总计(总和) LocationHostname PT1M 是的
网关请求 未授权的网关请求(已弃用)

未经授权的网关请求数 - 请改用包含 GatewayResponseCodeCategory 维度的多维请求指标
UnauthorizedRequests 计数 总计(总和) LocationHostname PT1M 是的
网关 WebSocket WebSocket 消息(预览)

基于所选源和目标的 WebSocket 消息计数
WebSocketMessages 计数 总计(总和)、平均值 LocationSourceDestination PT1M 是的

指标维度

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

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

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

API 管理 Microsoft.ApiManagement/service

活动日志

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

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