Trabajar con métricas para API HTTP - Amazon API Gateway

Trabajar con métricas para API HTTP

Puede monitorear la ejecución de la API mediante CloudWatch, que recopila y procesa datos sin formato de API Gateway en métricas legibles casi en tiempo real. Estas estadísticas se registran durante un periodo de 15 meses, para que pueda obtener acceso a información de historial y obtener una mejor perspectiva acerca del desempeño de su aplicación web o servicio. De forma predeterminada, los datos de las métricas de API Gateway se envían automáticamente a CloudWatch en períodos de un minuto. Para supervisar sus métricas, cree un panel de CloudWatch para la API. Para obtener más información sobre cómo crear un panel de CloudWatch, consulte Creación de un panel de CloudWatch en la Guía del usuario de Amazon CloudWatch. Para obtener más información, consulte ¿Qué es Amazon CloudWatch? en la guía del usuario de Amazon Cloudwatch.

Las siguientes métricas son compatibles con las API HTTP. También puede habilitar métricas detalladas para escribir métricas en el nivel de ruta en Amazon CloudWatch.

Métrica Descripción
4xx El número de errores del cliente capturados en un periodo determinado.
5xx El número de errores del servidor capturados en un periodo determinado.
Recuento El número total de solicitudes de API en un periodo de tiempo determinado.
IntegrationLatency Es el tiempo entre que API Gateway transmite una solicitud al backend y se recibe una respuesta del backend.
Latency (Latencia) El tiempo entre que API Gateway recibe una solicitud de un cliente y devuelve una respuesta al cliente. La latencia incluye la latencia de la integración y otra carga de API Gateway.
Datos procesados La cantidad de datos procesados en bytes.

Puede usar las dimensiones de la tabla siguiente para filtrar las métricas de API Gateway.

Dimensión Descripción
ApiId Filtra las métricas de API Gateway para una API con el ID de API especificado.
ApiId, Stage Filtra las métricas de API Gateway para una etapa de API cuyos ID de API y de etapa se hayan especificado.
ApiId, método, recurso, etapa

Filtra las métricas de API Gateway para un método de API con el ID de API, el ID de etapa, la ruta de recursos y el ID de enrutamiento específicos.

API Gateway no enviará estas métricas a menos que haya habilitado explícitamente las métricas detalladas de CloudWatch. Puede hacerlo mediante una llamada a la acción UpdateStage de la API de REST de API Gateway V2 para actualizar la propiedad detailedMetricsEnabled en true. También puede llamar al comando update-stage AWS CLI para actualizar la propiedad DetailedMetricsEnabled a true. Si activa estas métricas, se le cobrarán cargos adicionales en su cuenta. Para obtener más información sobre precios, consulte Precios de Amazon CloudWatch.