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.
Category | Métrica | Nombre en la API de REST | Unidad | Agregación | Dimensiones | Intervalos de agregación | Exportación de DS |
---|---|---|---|---|---|---|---|
Solicitudes de puerta de enlace | Duración de las solicitudes de back-end Duración de las solicitudes de back-end en milisegundos |
BackendDuration |
MilliSeconds | Promedio, Máximo, Mínimo | Location , , Hostname , ApiId |
PT1M | Sí |
Capacity | 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 | Sí |
WebSocket de puerta de enlace | 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 |
Count | Total (Suma), Promedio | Location , Source , , Destination , State |
PT1M | Sí |
Capacity | 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 | <none> | PT1M | Sí |
Solicitudes de puerta de enlace | Duración total de las solicitudes de puerta de enlace Duración total de las solicitudes de puerta de enlace en milisegundos |
Duration |
MilliSeconds | Promedio, Máximo, Mínimo | Location , , Hostname , ApiId |
PT1M | Sí |
Eventos de EventHub | Eventos de EventHub descartados Número de eventos omitidos por haber alcanzado el límite del tamaño de la cola |
EventHubDroppedEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Eventos de EventHub rechazados Número de eventos EventHub rechazados (configuración incorrecta o no autorizados) |
EventHubRejectedEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Eventos de EventHub correctos Número de eventos EventHub correctos |
EventHubSuccessfulEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Eventos de EventHub limitados Número de eventos EventHub limitados |
EventHubThrottledEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Eventos de EventHub agotados Número de eventos EventHub con tiempo de espera agotado |
EventHubTimedoutEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Tamaño de eventos de EventHub Tamaño total de los eventos EventHub en bytes |
EventHubTotalBytesSent |
Bytes | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Total de eventos de EventHub Número de eventos enviados a EventHub |
EventHubTotalEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Eventos de EventHub | Eventos de EventHub con errores Número de eventos EventHub con errores |
EventHubTotalFailedEvents |
Count | Total (Suma) | Location |
PT1M | Sí |
Solicitudes de puerta de enlace | 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 |
Count | Total (Suma) | Location , Hostname |
PT1M | Sí |
Capacity | 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 | <none> | PT1M | Sí |
Estado de red | 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 |
Count | Total (Suma), Promedio | Location , ResourceType |
PT1M | Sí |
Solicitudes de puerta de enlace | 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 |
Count | Total (Suma) | Location , Hostname |
PT1M | Sí |
Solicitudes de puerta de enlace | Solicitudes Métricas de solicitud de puerta de enlace con varias dimensiones |
Requests |
Count | Total (Suma), Máximo, Mínimo | Location , Hostname , LastErrorReason , BackendResponseCode , GatewayResponseCode , BackendResponseCodeCategory , , GatewayResponseCodeCategory ApiId |
PT1M | Sí |
Solicitudes de puerta de enlace | 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 |
Count | Total (Suma) | Location , Hostname |
PT1M | Sí |
Solicitudes de puerta de enlace | 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 |
Count | Total (Suma) | Location , Hostname |
PT1M | Sí |
Solicitudes de puerta de enlace | 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 |
Count | Total (Suma) | Location , Hostname |
PT1M | Sí |
WebSocket de puerta de enlace | Mensajes de WebSocket (versión preliminar) Recuento de mensajes de WebSocket basados en el origen y el destino seleccionados. |
WebSocketMessages |
Count | Total (Suma), Promedio | Location , , Source , Destination |
PT1M | Sí |
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.
- ApiId
- BackendResponseCode
- BackendResponseCodeCategory
- Destino
- GatewayResponseCode
- GatewayResponseCodeCategory
- Nombre de host
- LastErrorReason
- Location
- ResourceType
- Source
- Estado
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
Category | 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 | Costos para exportar |
---|---|---|---|---|---|---|
DeveloperPortalAuditLogs |
Registros relacionados con el uso del Portal para desarrolladores | APIMDevPortalAuditDiagnosticLog Registros de diagnóstico para API Management Developer Portal API. |
Sí | No | Sí | |
GatewayLlmLogs |
Registros relacionados con la puerta de enlace de IA generativa | No | No | Sí | ||
GatewayLogs |
Registros relacionados con la puerta de enlace de ApiManagement | ApiManagementGatewayLogs Registros de puerta de enlace de Azure ApiManagement. |
Sí | Sí | 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. |
Sí | No | Sí |
Registros de recursos admitidos para Microsoft.ApiManagement/service/workspaces
Category | 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 | Costos para exportar |
---|---|---|---|---|---|---|
GatewayLogs |
Registros de puerta de enlace para áreas de trabajo de API Management | No | No | Sí |
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
- APIMDevPortalAuditDiagnosticLog
- AzureActivity
- AzureMetrics
- AzureDiagnostics
- ApiManagementGatewayLogs
- ApiManagementWebSocketConnectionLogs
Registro de actividad
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.
Contenido relacionado
- Consulte Supervisión de API Management para obtener una descripción de la supervisión de Azure API Management.
- Consulte Supervisión de los recursos de Azure con Azure Monitor para obtener información sobre la supervisión de los recursos de Azure.