Tutorial: Supervisión de las API publicadas

Artículo
07/27/2022
Tiempo de lectura: 6 minutos

Con Azure Monitor, puede visualizar, consultar, enrutar, archivar y realizar acciones sobre las métricas o los registros procedentes del servicio Azure API Management.

En este tutorial, aprenderá a:

Visualización de las métricas de las API
Configuración de una regla de alerta
Visualización de registros de actividad
Habilitamiento y visualización de registros de recursos

También puede usar el análisis integrado de API Management para supervisar el uso y el rendimiento de las API.

Requisitos previos

Conocer la terminología de API Management de Azure.
Complete el siguiente inicio rápido: Creación de una instancia de Azure API Management.
Además, realice el siguiente tutorial: Importación y publicación de la primera API.

Disponibilidad

Importante

Esta característica está disponible en los niveles Premium, Estándar, Básico y Desarrollador de API Management.

Visualización de las métricas de las API

API Management emite métricas cada minuto, lo que le ofrece visibilidad casi en tiempo real sobre el estado y el mantenimiento de las API. Las siguientes son las dos métricas que se usan con más frecuencia. Para obtener una lista de todas las métricas disponibles, consulte las métricas compatibles.

Capacity (Capacidad): ayuda a tomar decisiones acerca de cómo actualizar o degradar los servicios de APIM. La métrica se emite por minuto y refleja la capacidad de la puerta de enlace en el momento del informe. La métrica oscila entre 0 y 100, y se calcula en función de los recursos de la puerta de enlace, como el uso de la CPU y de la memoria.
Requests (Solicitudes): ayuda a analizar el tráfico de API que pasa por los servicios API Management. La métrica se emite por minuto e informa del número de solicitudes de puerta de enlace con dimensiones. Filtre las solicitudes por códigos de respuesta, ubicación, nombre de host y errores.

Importante

Las siguientes métricas han quedado en desuso a partir de mayo de 2019 y se retirarán en agosto de 2023: Total Gateway Requests (Solicitudes totales de puerta de enlace), Successful Gateway Requests (Solicitudes de puerta de enlace correctas), Unauthorized Gateway Requests (Solicitudes de puerta de enlace no autorizadas), Failed Gateway Requests (Solicitudes de puerta de enlace con error), Other Gateway Requests (Otras solicitudes de puerta de enlace). Migre a la métrica Requests (Solicitudes), que proporciona una funcionalidad equivalente.

Screenshot of Metrics in API Management Overview

Para acceder a la métrica:

Vaya a la instancia de API Management en Azure Portal. En la página Información general, revise las métricas clave de las API.
Para investigar las métricas con más detenimiento, seleccione Métricas en el menú situado cerca de la parte inferior de la página.
En la lista desplegable, seleccione las métricas que le interesen. Por ejemplo, Requests.
El gráfico muestra el número total de llamadas API.
Puede filtrar el gráfico mediante las dimensiones de la métrica de Solicitudes. Por ejemplo, seleccione Agregar filtro, Backend Response Code Category (Categoría del código de respuesta de back-end) y escriba 500 como valor. El gráfico muestra el número de solicitudes erróneas en el back-end de la API.

Configuración de una regla de alerta

Puede recibir alertas basadas en métricas y registros de actividad. Azure Monitor permite configurar una alerta que haga lo siguiente cuando se desencadena:

Enviar una notificación por correo electrónico
Llamar a un webhook
Invocar una aplicación lógica de Azure

Para configurar una regla de alerta de ejemplo basada en una métrica de solicitud:

Vaya a la instancia de API Management en Azure Portal.
Seleccione Alertas en la barra de menús cerca de la parte inferior de la página.
Seleccione + Nueva regla de alertas.
En la ventana Crear regla de alerta, haga clic en Seleccionar condición.
En la ventana Configurar lógica de señal:
1. En Tipo de señal, seleccione Métricas.
2. En Nombre de señal, seleccione Métricas.
3. En Split by dimensions (Dividir por dimensiones), en Nombre de dimensión, seleccione Gateway Response Code Category (Categoría de código de respuesta de puerta de enlace).
4. En Valores de dimensión, seleccione 4xx, para errores de cliente como solicitudes no autorizadas o no válidas.
5. En Lógica de alerta, especifique un valor umbral después del cual se debe activar la alerta.
6. En Se evaluó basándose en, especifique Granularidad de agregación y Frecuencia de evaluación y, a continuación, seleccione Listo.
Seleccione un grupo de acciones existente o cree uno nuevo. En el siguiente ejemplo, se crea un nuevo grupo de acciones. Se enviará un correo electrónico de notificación a admin@contoso.com.
Escriba un nombre y la descripción de la regla de alertas y seleccione el nivel de gravedad.
Seleccione Crear regla de alertas.
Ahora, pruebe la regla de alertas mediante una llamada a Conference API sin una clave de API. Por ejemplo:
```
curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1 
```
Una alerta se desencadena en función del período de evaluación y envía un correo electrónico a admin@contoso.com.

Las alertas también aparecen en la página Alertas de la instancia de API Management.

Registros de actividad

Los registros de actividad proporcionan conclusión cognitiva sobre las operaciones en los servicios API Management. Con los registros de actividades, puede determinar los interrogantes “qué, quién y cuándo” de las operaciones de escritura (PUT, POST, DELETE) llevadas a cabo en los servicios API Management.

Nota

Los registros de actividad no incluyen las operaciones de lectura (GET) ni las realizadas en Azure Portal o mediante las API de administración originales.

Puede acceder a registros de actividad en el servicio API Management o a los registros de todos los recursos de Azure en Azure Monitor.

Screenshot of activity log in portal

Para ver el registro de actividad:

Vaya a la instancia de API Management en Azure Portal.
Seleccione Registro de actividad.
Seleccione el ámbito de filtrado que desee y seleccione Aplicar.

Registros del recurso

Los registros de recurso proporcionan información valiosa acerca de las operaciones y los errores que son importantes para la auditoría y para solucionar problemas. Los registros de recurso son diferentes de los registros de actividad. El registro de actividad proporciona información detallada sobre las operaciones ejecutadas en los recursos de Azure. Los registros de recurso proporcionan información detallada sobre las operaciones que ejecuta el recurso.

Para configurar los registros de recurso:

Vaya a la instancia de API Management en Azure Portal.
Seleccione Configuración de diagnóstico.
Seleccione + Agregar configuración de diagnóstico.
Seleccione los registros o métricas que desea recopilar.

Los registros de recurso se pueden archivar junto con las métricas en una cuenta de almacenamiento, transmitirlos en secuencias a un centro de eventos o enviarlos a un área de trabajo de Log Analytics.

Para más información, consulte Creación de una configuración de diagnóstico para enviar registros de plataforma y métricas a diferentes destinos.

Visualización de datos de diagnóstico en Azure Monitor

Si habilita la recopilación de registros de GatewayLogs o métricas en un área de trabajo de Log Analytics, los datos pueden tardar unos minutos en aparecer en Azure Monitor. Para ver los datos:

Vaya a la instancia de API Management en Azure Portal.
Seleccione Registros en el menú situado cerca de la parte inferior de la página.

Ejecute consultas para ver los datos. Se proporcionan varias consultas de ejemplo, pero también puede ejecutar la suya propia. Por ejemplo, la consulta siguiente recupera las 24 horas de datos más recientes de la tabla GatewayLogs:

ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

Para más información acerca del uso de registros de recursos para API Management, consulte:

El siguiente JSON indica una entrada de ejemplo en GatewayLogs para una solicitud de API correcta. Para más información, consulte la referencia del esquema.

{
    "Level": 4,
    "isRequestSuccess": true,
    "time": "2020-10-14T17:xx:xx.xx",
    "operationName": "Microsoft.ApiManagement/GatewayLogs",
    "category": "GatewayLogs",
    "durationMs": 152,
    "callerIpAddress": "xx.xx.xxx.xx",
    "correlationId": "3f06647e-xxxx-xxxx-xxxx-530eb9f15261",
    "location": "East US",
    "properties": {
        "method": "GET",
        "url": "https://apim-hello-world.azure-api.net/conference/speakers",
        "backendResponseCode": 200,
        "responseCode": 200,
        "responseSize": 41583,
        "cache": "none",
        "backendTime": 87,
        "requestSize": 526,
        "apiId": "demo-conference-api",
        "operationId": "GetSpeakers",
        "apimSubscriptionId": "master",
        "clientTime": 65,
        "clientProtocol": "HTTP/1.1",
        "backendProtocol": "HTTP/1.1",
        "apiRevision": "1",
        "clientTlsVersion": "1.2",
        "backendMethod": "GET",
        "backendUrl": "https://conferenceapi.azurewebsites.net/speakers"
    },
    "resourceId": "/SUBSCRIPTIONS/<subscription ID>/RESOURCEGROUPS/<resource group>/PROVIDERS/MICROSOFT.APIMANAGEMENT/SERVICE/APIM-HELLO-WORLD"
}

Pasos siguientes

En este tutorial, ha aprendido a:

Visualización de las métricas de las API
Configuración de una regla de alerta
Visualización de registros de actividad
Habilitamiento y visualización de registros de recursos

Avance hasta el siguiente tutorial:

Seguimiento de llamadas