Tutorial: Supervisión de las API publicadas

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

Nota

API Management admite una serie de herramientas adicionales para observar las API, incluidos el análisis integrado y la integración con Application Insights. Más información

Requisitos previos

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: Permite tomar decisiones acerca de cómo actualizar o degradar los servicios de API Management. La métrica se emite por minuto y refleja la capacidad de la puerta de enlace en el momento de generar el 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:

  1. Vaya a la instancia de API Management en Azure Portal. En la página Información general, en la pestaña Monitor, revise las métricas clave de las API.

  2. Para investigar las métricas en detalle, seleccione Métricas en el menú de la izquierda.

    Screenshot of Metrics item in Monitoring menu in the portal.

  3. En la lista desplegable, seleccione las métricas que le interesen. Por ejemplo, Requests.

  4. El gráfico muestra el número total de llamadas API. Ajuste el intervalo de tiempo para centrarse en períodos de interés.

  5. Puede filtrar el gráfico mediante las dimensiones de la métrica de Solicitudes. Por ejemplo, seleccione Agregar filtro, Backend Response Code Category y especifique 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. En Azure Monitor, configure una regla de alertas para realizar una acción cuando se desencadene. Entre las acciones comunes, se incluyen:

  • 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:

  1. Vaya a la instancia de API Management en Azure Portal.

  2. Seleccionar alertas en el menú de la izquierda.

    Screenshot of Alerts option in Monitoring menu in the portal.

  3. Seleccione + Crear>Regla de alerta.

  4. En la ventana Seleccionar una señal en la pestaña Condición:

    1. En Tipo de señal, seleccione Métricas.
    2. En Nombre de señal, seleccione Métricas.
    3. En Alert logic, especifique un valor umbral, que es el número de repeticiones después del cual se activará la alerta.
    4. 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).
    5. En Valores de dimensión, seleccione 4xx, para errores de cliente como solicitudes no autorizadas o no válidas. Si el valor de dimensión no aparece, seleccione Agregar valor personalizado y escriba 4xx.
    6. En When to evaluate, acepte la configuración predeterminada o seleccione otras opciones para configurar la frecuencia con la que se ejecutará la regla. Seleccione Siguiente.

    Screenshot of configuring alert logic in the portal.

  5. En la pestaña Acciones, seleccione o cree uno o varios grupos de acciones para notificar a los usuarios sobre la alerta y realizar una acción. Por ejemplo, cree un nuevo grupo de acciones para enviar un correo electrónico de notificación a admin@contoso.com. Para obtener pasos detallados, consulte Creación y administración de grupos de acciones en Azure Portal.

    Screenshot of configuring notifications for new action group in the portal.

  6. En la pestaña Detalles de Crear una regla de alertas, escriba un nombre y una descripción para la regla de alertas y seleccione el nivel de gravedad.

  7. Opcionalmente, configure los demás valores: En la pestaña Revisar y crear, seleccione Crear.

  8. 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.

    Screenshot of alerts in portal.

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:

  1. Vaya a la instancia de API Management en Azure Portal.

  2. Seleccione Registro de actividad.

    Screenshot of Activity log item in Monitoring menu in the portal.

  3. Seleccione el ámbito de filtrado que desee y seleccione Aplicar.

Registros del recurso

Los registros de recurso (registros de Azure Monitor) proporcionan información valiosa sobre las operaciones y los errores de API Management que son importantes para la auditoría y para la resolución de problemas. Cuando se habilita a través de una configuración de diagnóstico, los registros recopilan información sobre las solicitudes de API recibidas y procesadas por la puerta de enlace de API Management.

Nota:

El nivel Consumo no admite la recopilación de los registros de recursos.

Para configurar los registros de recurso:

  1. Vaya a la instancia de API Management en Azure Portal.

  2. Seleccione Configuración de diagnóstico.

    Screenshot of Diagnostic settings item in Monitoring menu in the portal.

  3. Seleccione + Agregar configuración de diagnóstico.

  4. Seleccione los registros o métricas que desea recopilar.

    Tiene varias opciones sobre dónde enviar los registros y las métricas. Por ejemplo, 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.

    Sugerencia

    Si selecciona un área de trabajo de Log Analytics, puede elegir almacenar los datos en la tabla ApiManagementGatewayLogs específica del recurso o almacenarlos en la tabla general AzureDiagnostics. Se recomienda usar la tabla específica del recurso para destinos de registro que lo admitan. Más información

  5. Después de configurar los detalles del destino o los destinos del registro, seleccione Guardar.

Nota:

Agregar un objeto de configuración de diagnóstico podría producir un error si la propiedad MinApiVersion del servicio API Management está establecida en cualquier versión de API superior a 2022-09-01-versión preliminar.

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 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:

  1. Vaya a la instancia de API Management en Azure Portal.

  2. Seleccione Registros en el menú de la izquierda.

    Screenshot of Logs item in Monitoring menu in the portal.

  3. 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) 
    

    Screenshot of querying ApiManagementGatewayLogs table in the portal.

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

Modificación de la configuración del registro de API

De forma predeterminada, al crear una configuración de diagnóstico para habilitar la recopilación de registros de recursos, el registro está habilitado para todas las API, con la configuración predeterminada. Puede ajustar la configuración de registro de todas las API o invalidarlas para las API individuales. Por ejemplo, ajuste la frecuencia de muestreo o el nivel de detalle de los datos, o deshabilite el registro de algunas API.

Para obtener más información sobre la configuración de registro, consulte Referencia de configuración de registro de diagnóstico.

Para configurar los valores de registro para todas las API:

  1. En el panel de navegación izquierdo de la instancia de API Management, seleccione API>Todas las API.
  2. Seleccione la pestaña Configuración en la barra superior.
  3. Desplácese hacia abajo hasta la sección Registros de diagnóstico y seleccione la pestaña Azure Monitor.
  4. Revise la configuración de los parámetros y haga los cambios que considere necesarios. Seleccione Guardar.

Para configurar los valores de registro de una API específica:

  1. En el menú izquierdo de la instancia de API Management, seleccione API y, a continuación, el nombre de la API.
  2. Seleccione la pestaña Configuración en la barra superior.
  3. Desplácese hacia abajo hasta la sección Registros de diagnóstico y seleccione la pestaña Azure Monitor.
  4. Revise la configuración de los parámetros y haga los cambios que considere necesarios. Seleccione Guardar.

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: