Compartir a través de

Tutorial: Supervisión de las API publicadas

SE APLICA A: todos los niveles de API Management

Con Azure Monitor, puede visualizar, consultar, enrutar, archivar y realizar acciones sobre las métricas o los registros procedentes del servicio Azure API Management. Para obtener información general sobre Azure Monitor para API Management, consulte Monitor API Management.

Sugerencia

Los equipos de API pueden usar esta característica en áreas de trabajo. Las áreas de trabajo proporcionan acceso administrativo aislado a las API y sus propios entornos de tiempo de ejecución de API.

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. A continuación se muestran las métricas más usadas. Para obtener una lista de todas las métricas disponibles, consulte Métricas.

  • 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 calculadas en función de los recursos de puerta de enlace, como el uso de CPU y memoria y otros factores.

    Sugerencia

    En los niveles de servicio v2 y en las puertas de enlace del área de trabajo, API Management ha reemplazado la métrica de capacidad de la puerta de enlace por métricas independientes de uso de CPU y memoria. Estas métricas también se pueden usar para tomar decisiones de escalado y solucionar problemas. Más información

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

Nota:

La métrica de solicitudes no está disponible en espacios de trabajo.

Importante

Se han retirado las siguientes métricas: Total de solicitudes de puerta de enlace, Solicitudes de puerta de enlace correctas, Solicitudes de puerta de enlace no autorizadas, Solicitudes de puerta de enlace con errores, Otras solicitudes de puerta de enlace. Migre a la métrica Solicitudes, que proporciona una funcionalidad muy similar.

Captura de pantalla de Métricas en la información general de API Management

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 con detalle, seleccione Supervisión>Métricas en el menú de la izquierda.

    Captura de pantalla del elemento Métricas del menú Supervisión, en el portal

    Sugerencia

    En un área de trabajo, puede ver las métricas de capacidad en el ámbito de una puerta de enlace del área de trabajo. Vaya a Supervisión>Métricas en el menú izquierdo de una puerta de enlace del área de trabajo.

  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. Select Supervisión>Alertas en el menú de la izquierda.

    Captura de pantalla de la opción Alertas del menú Supervisión, en el portal.

  3. Seleccione + Crear>Regla de alerta.

  4. En la pestaña Condiciones,

    1. En Nombre de señal, seleccione Métricas.
    2. En Lógica de alerta, revise o modifique los valores predeterminados de la alerta. Por ejemplo, actualice el Umbral estático, que es el número de repeticiones después de las cuales se debe desencadenar la alerta.
    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. Si el valor de dimensión no aparece, seleccione Agregar valor personalizado y escriba 4xx.
    5. 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 Next (Siguiente).

    Captura de pantalla de la configuración de la lógica de alertas en el 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.

    Captura de pantalla de la configuración de notificaciones para el nuevo grupo de acciones en el 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. Opcionalmente, pruebe la regla de alertas mediante un cliente HTTP para simular una solicitud que desencadene la alerta. Por ejemplo, ejecute el siguiente comando en un terminal, sustituyendo el nombre de host de API Management por el nombre de host de la instancia de API Management:

    curl GET https://contoso.azure-api.net/non-existent-endpoint 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.

    Captura de pantalla de alertas en el 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 operaciones de lectura (GET) ni operaciones realizadas en Azure Portal.

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

Captura de pantalla del registro de actividad en el portal

Para ver el registro de actividad:

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

  2. Seleccione Registro de actividad.

    Captura de pantalla del elemento Registro de actividad del menú Supervisión, en el 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.

Sugerencia

En las instancias de API Management con áreas de trabajo, el equipo de la plataforma de API puede acceder a los registros federados en el servicio API Management para la supervisión centralizada de API, mientras que los equipos del área de trabajo pueden acceder a los registros específicos de las API de su área de trabajo. Obtén más información sobre el registro de actividad de Azure Monitor con áreas de trabajo

Para configurar una configuración de diagnóstico para la recopilación de registros de recursos:

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

  2. En el menú de la izquierda, en Supervisión, seleccione Configuración de diagnóstico>+ Agregar configuración de diagnóstico.

    Captura de pantalla de la adición de una configuración de diagnóstico en el portal.

  3. En la página configuración de diagnóstico, escriba o seleccione los detalles de la configuración:

    1. Nombre de configuración de diagnóstico: escriba un nombre descriptivo.
    2. Grupos de categorías: si lo desea, realice una selección para su escenario.
    3. En Categorías: seleccione una o varias categorías. Por ejemplo, seleccione Registros relacionados con ApiManagement Gateway para recopilar registros de la mayoría de las solicitudes a la puerta de enlace de API Management.
    4. En Detalles de destino, seleccione una o varias opciones y especifique los detalles del destino. Por ejemplo, enviar registros a un área de trabajo de Azure Log Analytics, archivar registros en una cuenta de almacenamiento o transmitirlos a un centro de eventos. Para más información, consulte Configuración de diagnóstico en Azure Monitor.
    5. Seleccione Guardar.

    Sugerencia

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

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

Nota:

Para habilitar la configuración de diagnóstico para las áreas de trabajo de API Management, consulte Creación y administración de un área de trabajo.

Visualización de registros y métricas en Azure Log Analytics

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. En el menú izquierdo, en Supervisión, seleccione Registros.

  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)

    Captura de pantalla de la consulta de la tabla ApiManagementGatewayLogs en el 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

Cuando se usa el portal para crear una configuración de diagnóstico para habilitar la recopilación de registros de puerta de enlace de API Management o puerta de enlace de IA generativa (LLM), el registro se habilita con la configuración predeterminada. La configuración predeterminada no incluye detalles de las solicitudes o respuestas, como los cuerpos de solicitud o respuesta. 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 de registro de la puerta de enlace, habilite el registro de mensajes de solicitud o respuesta de LLM o deshabilite el registro de algunas API.

Para obtener más información sobre la configuración de registro, consulte las páginas de referencia de la API Diagnostic - Create or Update y Diagnostic - Create or Update REST API (Diagnóstico: creación o actualización de API).

Para configurar los valores de registro para todas las API:

  1. En el menú izquierdo de la instancia de API Management, seleccione API>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>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.

Importante

API Management aplica un límite de 32 KB para el tamaño de las entradas de registro enviadas a Azure Monitor. El comportamiento cuando una entrada de registro supera el límite depende de la categoría de registro y de los atributos de datos registrados:

  • Registros de puerta de enlace de API Management: las cargas de solicitud o respuesta registradas en una entrada de registro, si se recopilan, pueden tener hasta 8 192 bytes cada una. Si el tamaño combinado de los atributos de una entrada supera los 32 KB, API Management recorta la entrada quitando todo el cuerpo y el contenido de seguimiento.
  • Registros de puerta de enlace de IA generativa: los mensajes de solicitud o respuesta de LLM de hasta 32 KB de tamaño, si se recopilan, se envían en una sola entrada. Los mensajes de más de 32 KB se dividen y registran en fragmentos de 32 KB con números de secuencia para la reconstrucción posterior. Los mensajes de solicitud y los mensajes de respuesta no pueden superar los 2 MB cada uno.

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