Compartir a través de


Referencia de datos de supervisión de API Management

SE APLICA A: todos los niveles de API Management

Este artículo contiene toda la información de referencia de supervisión de este servicio.

Consulte Supervisión de API Management para más información sobre los datos que puede recopilar para Azure API Management y cómo usarlo.

Métricas

En esta sección se indican todas las métricas de la plataforma recopiladas automáticamente para este servicio. Estas métricas también forman parte de la lista global de todas las métricas de plataforma admitidas en Azure Monitor.

Para obtener información sobre la retención de métricas, consulte Información general sobre las métricas de Azure Monitor.

Métricas admitidas para Microsoft.ApiManagement/service

En la tabla siguiente se enumeran las métricas disponibles para el tipo de recurso Microsoft.ApiManagement/service.

  • Es posible que todas las columnas no estén presentes en todas las tablas.
  • Es posible que algunas columnas estén fuera del área de visualización de la página. Seleccione Expandir tabla para ver todas las columnas disponibles.

Encabezados de tabla

  • Categoría: el grupo de métricas o la clasificación.
  • Métrica: el nombre para mostrar de la métrica tal como aparece en Azure Portal.
  • Nombre en la API REST: el nombre de la métrica por el que se conoce en la API REST.
  • Unidad: unidad de medida.
  • Agregación: el tipo de agregación predeterminado. Valores válidos: promedio (Avg), mínimo (Min), máximo (Max), total (Sum), recuento.
  • Dimensiones - : dimensiones disponibles para la métrica.
  • Intervalos de agregación - : intervalos en los que se obtiene una muestra de la métrica. Por ejemplo, PT1M indica que la métrica se muestrea cada minuto, PT30M cada 30 minutos, PT1H cada hora, etc.
  • Exportación de DS: indica si la métrica se puede exportar a los registros de Azure Monitor a través de la configuración de diagnóstico. Para obtener más información sobre la exportación de métricas, consulte Crear configuración de diagnóstico en Azure Monitor.

Categoría: Capacidad

Métrica Nombre en la API de REST Unidad Agregación Dimensiones Intervalos de agregación Exportación de DS
Capacidad

Métrica de uso para el servicio ApiManagement. Nota: En el caso de skus que no Premium, la agregación "Max" mostrará el valor como 0.
Capacity Porcentaje Promedio, máximo Location PT1M
Porcentaje de CPU de la puerta de enlace

Porcentaje de CPU de la puerta de enlace para los servicios SKUv2
CpuPercent_Gateway Porcentaje Promedio, máximo <ninguno> PT1M
Porcentaje de memoria de la puerta de enlace

Porcentaje de memoria de la puerta de enlace para los servicios SKUv2
MemoryPercent_Gateway Porcentaje Promedio, máximo <ninguno> PT1M

Categoría: Eventos de EventHub

Métrica Nombre en la API de REST Unidad Agregación Dimensiones Intervalos de agregación Exportación de DS
Eventos de EventHub descartados

Número de eventos omitidos por haber alcanzado el límite del tamaño de la cola
EventHubDroppedEvents Contar Total (Suma) Location PT1M
Eventos de EventHub rechazados

Número de eventos EventHub rechazados (configuración incorrecta o no autorizados)
EventHubRejectedEvents Contar Total (Suma) Location PT1M
Eventos de EventHub correctos

Número de eventos EventHub correctos
EventHubSuccessfulEvents Contar Total (Suma) Location PT1M
Eventos de EventHub limitados

Número de eventos EventHub limitados
EventHubThrottledEvents Contar Total (Suma) Location PT1M
Eventos de EventHub agotados

Número de eventos EventHub con tiempo de espera agotado
EventHubTimedoutEvents Contar Total (Suma) Location PT1M
Tamaño de eventos de EventHub

Tamaño total de los eventos EventHub en bytes
EventHubTotalBytesSent Bytes (unidades de información digital) Total (Suma) Location PT1M
Total de eventos de EventHub

Número de eventos enviados a EventHub
EventHubTotalEvents Contar Total (Suma) Location PT1M
Eventos de EventHub con errores

Número de eventos EventHub con errores
EventHubTotalFailedEvents Contar Total (Suma) Location PT1M

Categoría: Solicitudes de puerta de enlace

Métrica Nombre en la API de REST Unidad Agregación Dimensiones Intervalos de agregación Exportación de DS
Duración de las solicitudes de back-end

Duración de las solicitudes de back-end en milisegundos
BackendDuration Milisegundos Promedio, Máximo, Mínimo Location, , Hostname, ApiId PT1M
Duración total de las solicitudes de puerta de enlace

Duración total de las solicitudes de puerta de enlace en milisegundos
Duration Milisegundos Promedio, Máximo, Mínimo Location, , Hostname, ApiId PT1M
Solicitudes de puerta de enlace con error (en desuso)

Número de errores en las solicitudes de puerta de enlace: use la métrica de solicitud de varias dimensiones con la dimensión GatewayResponseCodeCategory en su lugar.
FailedRequests Contar Total (Suma) Location, Hostname PT1M
Otras solicitudes de puerta de enlace (en desuso)

Número de solicitudes de puerta de enlace de otro tipo: use la métrica de solicitud de varias dimensiones con la dimensión GatewayResponseCodeCategory en su lugar.
OtherRequests Contar Total (Suma) Location, Hostname PT1M
Solicitudes

Métricas de solicitud de puerta de enlace con varias dimensiones
Requests Contar Total (Suma), Máximo, Mínimo Location, Hostname, LastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, , GatewayResponseCodeCategoryApiId PT1M
Solicitudes de puerta de enlace correctas (en desuso)

Número de solicitudes de puerta de enlace correctas: use la métrica de solicitud de varias dimensiones con la dimensión GatewayResponseCodeCategory en su lugar.
SuccessfulRequests Contar Total (Suma) Location, Hostname PT1M
Total de solicitudes de puerta de enlace (en desuso)

Número de solicitudes de puerta de enlace: use la métrica de solicitud de varias dimensiones con la dimensión GatewayResponseCodeCategory en su lugar.
TotalRequests Contar Total (Suma) Location, Hostname PT1M
Solicitudes de puerta de enlace no autorizadas (en desuso)

Número de solicitudes de puerta de enlace no autorizadas: use la métrica de solicitud de varias dimensiones con la dimensión GatewayResponseCodeCategory en su lugar.
UnauthorizedRequests Contar Total (Suma) Location, Hostname PT1M

Categoría: WebSocket de puerta de enlace

Métrica Nombre en la API de REST Unidad Agregación Dimensiones Intervalos de agregación Exportación de DS
Intentos de conexión de WebSocket (versión preliminar)

Recuento de intentos de conexión de WebSocket basados en el origen y el destino seleccionados.
ConnectionAttempts Contar Total (Suma), Promedio Location, Source, , Destination, State PT1M
Mensajes de WebSocket (versión preliminar)

Recuento de mensajes de WebSocket basados en el origen y el destino seleccionados.
WebSocketMessages Contar Total (Suma), Promedio Location, , Source, Destination PT1M

Categoría: Estado de red

Métrica Nombre en la API de REST Unidad Agregación Dimensiones Intervalos de agregación Exportación de DS
Estado de conectividad de red de recursos (versión preliminar)

Estado de conectividad de red de los tipos de recursos dependientes del servicio de API Management
NetworkConnectivity Contar Total (Suma), Promedio Location, ResourceType PT1M

Dimensiones de métricas

Para obtener más información sobre las dimensiones de métricas, consulte Métricas multidimensionales.

Este servicio tiene las siguientes dimensiones asociadas a sus métricas.

  • ID de API
  • BackendResponseCode
  • BackendResponseCodeCategory
  • Destino
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Nombre de host
  • RazónDelÚltimoError
  • Ubicación
  • TipoDeRecurso
  • Fuente
  • Estado

Métricas admitidas para Microsoft.ApiManagement/gateways

En la tabla siguiente se enumeran las métricas disponibles para el tipo de recurso Microsoft.ApiManagement/gateways.

Encabezados de tabla

Métrica: el nombre para mostrar de la métrica tal como aparece en Azure Portal.
Nombre en la API REST - Nombre de la métrica tal y como se menciona en la API REST.
Unidad: unidad de medida.
Agregación: el tipo de agregación predeterminado. Valores válidos: promedio, mínimo, máximo, total, recuento.
Dimensiones - : dimensiones disponibles para la métrica.
Granos de tiempo - Intervalos en los que se toma muestra de la métrica. Por ejemplo, PT1M indica que la métrica se muestrea cada minuto, PT30M cada 30 minutos, PT1H cada hora, etc.
Exportación de DS: indica si la métrica se puede exportar a los registros de Azure Monitor a través de la configuración de diagnóstico.

Para obtener información sobre cómo exportar métricas, consulte : Exportación de métricas mediante reglas de recopilación de datos y Creación de una configuración de diagnóstico en Azure Monitor.

Para obtener información sobre la retención de métricas, consulte Información general sobre las métricas de Azure Monitor.

Categoría: Uso

Métrica Nombre en la API de REST Unidad Agregación Dimensiones Intervalos de agregación Exportación de DS
Uso de CPU (%)

Uso total del procesador en todos los núcleos de la puerta de enlace de API.
CpuPercent_Gateway Porcentaje Promedio, máximo <ninguno> PT1M
Uso de memoria (%)

Porcentaje de memoria física en uso por procesos activos dentro de la puerta de enlace de API.
MemoryPercent_Gateway Porcentaje Promedio, máximo <ninguno> PT1M

Registros del recurso

En esta sección se enumeran los tipos de registros de recursos que se pueden recopilar para este servicio. La sección extrae de la lista de todos los tipos de categorías de registros admitidos en Azure Monitor.

Registros de recursos admitidos para Microsoft.ApiManagement/service

Categoría Nombre para mostrar de categoría Tabla de registro Admite el plan de registro básico Admite la transformación en tiempo de ingesta Consultas de ejemplo Costes de exportación
DeveloperPortalAuditLogs Registros relacionados con el uso del Portal para desarrolladores APIMDevPortalAuditDiagnosticLog

Registros de diagnóstico para API Management Developer Portal API.

No
GatewayLlmLogs Registros relacionados con la puerta de enlace de IA generativa ApiManagementGatewayLlmLog

Registros de puerta de enlace relacionados con modelos de lenguaje para API Management Language.

No
GatewayLogs Registros relacionados con la puerta de enlace de ApiManagement ApiManagementGatewayLogs

Registros de puerta de enlace de Azure ApiManagement.

Consultas No
WebSocketConnectionLogs Registros relacionados con las conexiones de Websocket ApiManagementWebSocketConnectionLogs

Los registros de conexión de Websocket proporcionan registros en eventos de conexión de websocket para API Management Gateway. El registro se inicia cuando llega la solicitud a API Management Gateway para el protocolo de enlace y hasta que se finaliza la solicitud. Cada registro de solicitudes se puede identificar de forma única con CorrelationId.

No

Registros de recursos admitidos para Microsoft.ApiManagement/service/workspaces

Categoría Nombre para mostrar de categoría Tabla de registro Admite el plan de registro básico Admite la transformación en tiempo de ingesta Consultas de ejemplo Costes de exportación
GatewayLogs Registros de puerta de enlace para áreas de trabajo de API Management AzureDiagnostics

Registros de varios recursos de Azure.

No No

Tablas de registros de Azure Monitor

En esta sección, se enumeran todas las tablas de registros de Azure Monitor relacionadas con este servicio y que están disponibles para consulta mediante Log Analytics con consultas de Kusto. Las tablas contienen datos de registro de recursos y, posiblemente, más dependiendo de lo que se recopila y se enrutan a ellos.

API Management Microsoft.ApiManagement/service

Registro de actividades

En la tabla vinculada se enumeran las operaciones que se pueden registrar en el registro de actividad de este servicio. Estas operaciones son un subconjunto de todas las posibles operaciones del proveedor de recursos en el registro de actividad.

Para obtener más información sobre el esquema de las entradas del registro de actividad, consulte Esquema del registro de actividad.