Cómo supervisar si un punto final de API Gateway es realmente accesible

Emitir síntomas

Es posible que vea uno o más de los siguientes síntomas:

• No hay ninguna señal de accesibilidad directa disponible para un punto final de gateway de API.

• Las métricas de API Gateway no muestran una métrica de estado dedicada.

• Las tendencias de volumen de tráfico, latencia y código de respuesta no confirman la duración del punto final.

• No se ha configurado ninguna comprobación del sistema nativa de OCI para el punto final de despliegue de API Gateway.

Causas posibles

Las métricas de accesibilidad de punto final y gateway miden diferentes partes de la ruta de solicitud:

• Comprobaciones del sistema indican si se puede acceder a una ruta de acceso de API desplegada desde la ubicación del sondeo de comprobación del sistema.

• Las métricas de gateway de API indican cómo se comporta el gateway después de que el tráfico llegue al gateway.

• Un gateway al que se puede acceder puede devolver respuestas 4xx o 5xx cada vez mayores.

• Un gateway con poco o ningún tráfico puede tener pocos puntos de datos de métricas recientes, lo que hace que las métricas por sí solas sean una señal de vida débil.

Configuración de una comprobación de estado para Endpoint Liveness

Utilice Comprobaciones del sistema cuando necesite una señal binaria o casi binaria de que se puede acceder a un punto final desplegado.

Seleccione una ruta de API que cumpla los siguientes requisitos:

• La ruta devuelve una respuesta correcta predecible, como 200 o 204.

• La ruta no dispara redirecciones de inicio de sesión.

• La ruta no necesita credenciales por usuario ni parámetros de consulta de corta duración.

• La ruta no realiza una operación de escritura ni crea un efecto de negocio.

• La ruta representa la ruta de gateway de API que desea supervisar.

Antes de crear la comprobación del sistema, verifique la ruta manualmente:

curl -i https://<gateway-hostname>/<deployment-path-prefix>/<api-route-path>

Cree una comprobación del sistema de OCI que tenga como destino el punto final desplegado exacto que ha verificado. Utilice la comprobación del sistema para los siguientes objetivos de supervisión:

• Accesibilidad al punto final.

• Comprobaciones de disponibilidad externas.

• Alerta cuando el punto final deja de responder con el código de estado esperado.

Revisión de métricas de gateway de API

Utilice las métricas de API Gateway para comprender el tráfico y los patrones de fallo una vez que se pueda acceder al punto final. En el explorador de métricas, revise las métricas de API Gateway públicas en el espacio de nombres oci_apigateway.

Comience con las siguientes métricas y dimensiones:

• HttpResponses, httpStatusCode y httpStatusCategory.

• BackendHttpResponses, backendHttpStatusCode y backendHttpStatusCategory.

• Latency, IntegrationLatency y InternalLatency.

• resourceId, deploymentId y route.

Utilice HttpResponses para revisar los códigos de estado devueltos por API Gateway. Utilice BackendHttpResponses para revisar los códigos de estado devueltos por los servicios de backend.

Interpretación de los resultados de supervisión

Utilice el estado de comprobación del sistema y las métricas de API Gateway juntas para identificar dónde se produce el problema:

• Si la comprobación del sistema falla, es posible que no se pueda acceder al punto final o que no esté en buen estado desde la ruta de sondeo.

• Si la comprobación del sistema se realiza correctamente, pero aumentan las respuestas 4xx o 5xx, se puede acceder al punto final, pero las solicitudes fallan.

• Si el tráfico es bajo y las métricas no muestran datos recientes, los datos que faltan no prueban que el gateway no está disponible.

• Si la accesibilidad se realiza correctamente, pero la latencia aumenta, se puede acceder al gateway, pero el procesamiento de solicitudes puede degradarse.

Corregir brechas de supervisión

Utilice la señal de supervisión que coincida con la pregunta que necesita responder:

• Para supervisar la actividad de los puntos finales, configure Comprobaciones del sistema para una ruta de API desplegada.

• Para investigar el comportamiento de la respuesta, revise las métricas de API Gateway.

• Para supervisar tanto la disponibilidad como el comportamiento, combine comprobaciones del sistema con métricas y alarmas de API Gateway.

• Para evitar conclusiones falsas, no confíe en una métrica de gateway de API como indicador directo activo de gateway.

Verificar supervisión de punto final

Después de configurar la supervisión de punto final, verifique la configuración:

• Confirme que la ruta de acceso de API seleccionada devuelve el código de estado esperado al probarlo con curl.

• Confirme que la comprobación del sistema de OCI pueda sondear el punto final correctamente.

• Confirme que el explorador de métricas muestra las tendencias de solicitud y respuesta para el gateway.

• Confirme que las alarmas distinguen los problemas de accesibilidad de punto final de los problemas de latencia o código de respuesta.

Para obtener más información

Para obtener más información, consulte:

• Comprobaciones del sistema

• Creación de una Supervisión de HTTP

• Métricas de API Gateway