Herramientas de supervisión en AWS para API Gateway

AWS proporciona varias herramientas que puede utilizar para monitorear API Gateway. Puede configurar algunas de estas herramientas para que monitoricen automáticamente, pero otras herramientas requieren intervención manual. Le recomendamos que automatice las tareas de monitorización en la medida de lo posible.

Herramientas de monitoreo automatizadas en AWS

Puede utilizar las siguientes herramientas de monitoreo automatizado para vigilar API Gateway e informar cuando haya algún problema:

• Alarmas de Amazon CloudWatch: vigile una métrica durante un periodo de tiempo especificado y realice una o varias acciones según el valor que tenga la métrica en comparación con un determinado umbral durante una serie de periodos de tiempo. La acción es una notificación enviada a un tema de Amazon Simple Notification Service (Amazon SNS) o a una política de Amazon EC2 Auto Scaling. Las alarmas de CloudWatch no invocan acciones tan solo por tener un estado determinado; es necesario que el estado haya cambiado y se mantenga durante un número específico de periodos. Para obtener más información, consulte Supervisión de la ejecución de la API de REST con métricas de Amazon CloudWatch.

• Registros de Amazon CloudWatch: monitorice, almacene y obtenga acceso a los archivos de registro de AWS CloudTrail u otras fuentes. Para obtener más información, consulte ¿Qué es registros de CloudWatch? en la Guía del usuario de Amazon CloudWatch.

• Amazon EventBridge (anteriormente se llamaba CloudWatch Events): seleccione los eventos y diríjalos hacia uno o varios flujos o funciones de destino para realizar cambios, capturar información de estado y aplicar medidas correctivas. Para obtener más información, consulte ¿Qué es Amazon EventBridge? en la Guía del usuario de EventBridge.

• Monitoreo de registros de AWS CloudTrail: comparta archivos de registro entre cuentas, monitoree los archivos de registro de CloudTrail en tiempo real enviándolos a CloudWatch Logs, escriba aplicaciones de procesamiento de registros en Java y compruebe que los archivos de registro no hayan cambiado después de que CloudTrail los entregara. Para obtener más información, consulte Uso de archivos de registro de CloudTrail en la Guía del usuario de AWS CloudTrail.

Herramientas de monitoreo manuales

Otra parte importante del monitoreo de API Gateway implica el monitoreo manual de los elementos que no cubren las alarmas de CloudWatch. Los paneles de API Gateway, CloudWatch y otras consolas de AWS proporcionan una vista rápida del estado del entorno de AWS. Es recomendable que también compruebe los archivos de registro de la ejecución de la API.

• Los paneles de API Gateway muestran las siguientes estadísticas para una etapa de API determinada durante un periodo de tiempo especificado:

  • API Calls (Llamadas a la API)

  • Cache Hit (Acierto de caché), solo cuando está habilitado el almacenamiento en caché de la API.

  • Cache Miss (Error de caché), solo cuando está habilitado el almacenamiento en caché de la API.

  • Latency (Latencia)

  • Integration Latency (Latencia de integración)

  • 4XX Error (Error 4XX)

  • 5XX Error (Error 5XX)

• La página principal de CloudWatch muestra:

  • Alarmas y estado actual

  • Gráficos de alarmas y recursos

  • Estado de los servicios

  Además, puede utilizar CloudWatch para hacer lo siguiente:

  • Crear paneles personalizados para monitorizar los servicios que le interesan

  • Realizar un gráfico con los datos de las métricas para resolver problemas y descubrir tendencias

  • Buscar y examinar todas sus métricas de recursos de AWS.

  • Crear y editar las alarmas de notificación de problemas

Creación de alarmas de CloudWatch para monitorear API Gateway

Puede crear una alarma de CloudWatch que envíe un mensaje de Amazon SNS cuando la alarma cambia de estado. Una alarma vigila una única métrica durante el período especificado y realiza una o varias acciones en función del valor de la métrica relativo a un determinado umbral durante una serie de períodos de tiempo. La acción es una notificación que se envía a un tema de Amazon SNS o a una política de escalado automático. Las alarmas invocan acciones únicamente para los cambios de estado prolongados. Las alarmas de CloudWatch no invocan acciones tan solo por tener un estado determinado; es necesario que el estado haya cambiado y se mantenga durante un número específico de periodos.