Analice una situación de muestra

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Sigue un ejemplo de situación que muestra cómo solucionar problemas 5xx con tus APIs.

#	Paso	Descripción
1	Supervisa el tráfico reciente de la API	Consulta los datos recientes de supervisión de la API para todos los proxies y destinos de API que tuvieron tráfico en la última hora. Analiza en detalle los proxies o destinos de API con un porcentaje de errores alto.
2	Identifica las tendencias en los datos de supervisión de la API	Accede a una vista histórica de los datos de supervisión de la API de hasta los últimos 3 meses para obtener una perspectiva más amplia.
3	Investiga los problemas 5xx	Consulta los códigos de falla que experimentan los volúmenes relativos más altos a lo largo del tiempo para investigar más a fondo la fuente de los problemas 5xx. (Por lo general, los códigos de estado 5xx se pueden clasificar con uno o más códigos de falla).
4	Configura una alerta 5xx	Configura una alerta para recibir una notificación cuando la cantidad de códigos de estado 5xx supere un umbral determinado.
5	Genera un informe personalizado con detalles del cliente (opcional)	De manera opcional, genera un informe personalizado para identificar detalles sobre el cliente que activa los errores 5xx. Nota: Para generar un informe personalizado, debes ser administrador de la organización.
6	Agrupa los proxies de API en una colección	Crea una colección para agrupar los proxies de API y configurar los valores de umbral de alerta adecuados para todos los miembros del grupo para diagnosticar problemas más rápido.
7	Resuelve los problemas 5xx	Según tu investigación y diagnóstico, toma las medidas adecuadas para resolver los problemas 5xx.

Paso 1: Supervisa el tráfico reciente de la API

Para ver los datos de supervisión de la API de los proxies y destinos de API que tuvieron tráfico en la última hora, haz lo siguiente:

1. Selecciona Analizar > Supervisión de API > Recientes en la IU de Edge para acceder al panel Recientes.

2. Observa los proxies y destinos de API que tuvieron un porcentaje de errores alto en la última hora.
   

3. Haz clic en el proxy o destino de API con un porcentaje de errores alto para ver los detalles en el panel derecho. Observa el alto porcentaje de errores 5xx en este ejemplo.

   

Para obtener más información sobre este paso, consulta Supervisa el tráfico reciente de la API.

Paso 2: Identifica las tendencias en los datos de supervisión de la API

Para acceder a una vista histórica de los datos de supervisión de la API de los proxies y destinos de API que tuvieron tráfico hasta los últimos tres meses, haz lo siguiente:

1. En el panel derecho del panel Recientes, selecciona > Ver en Cronograma para acceder al panel Cronograma. Como alternativa, puedes hacer clic en Analizar > Supervisión de API > Cronograma en la IU de Edge.
   
2. Consulta la tendencia del proxy de API o destino a lo largo del tiempo. Observa que la tendencia ha sido constante en los últimos 7 días.

Para obtener más información sobre este paso, consulta Identifica las tendencias en los datos de supervisión de la API.

Paso 3: Investiga los problemas 5xx

Apigee proporciona un conjunto de códigos de falla que te ayudan a diagnosticar problemas. Por lo general, los códigos de estado 5xx se pueden clasificar con uno o más códigos de falla.

Para investigar los problemas 5xx, haz lo siguiente:

1. En el panel derecho del panel Cronograma, selecciona > Ver en Investigar para acceder al panel Investigar. Como alternativa, puedes hacer clic en Analizar > Supervisión de API > Investigar en la IU de Edge.
   
   El panel Investigar te permite comparar la actividad relacional entre métricas, como el código de falla frente al tiempo.

2. Consulta la matriz de código de error frente al tiempo para ver la actividad del código de falla en la última hora. Observa los códigos de falla que experimentan los volúmenes relativos más altos según el sombreado de color de un bloque. Cuanto más oscuro sea el bloque, mayor será el volumen relativo.

   Por ejemplo, los códigos de falla policies.ratelimit.SpikeArrestViolation y policies.ratelimit.QuotaViolation muestran un volumen relativo más alto en la siguiente matriz:

3. Haz clic en el bloque más oscuro (primer bloque) de la fila policies.ratelimit.SpikeArrestViolation para ver más detalles en el panel derecho.
   

4. Observa que la fuente de la falla es el proxy de API perfBenchmark_invalid_v1 y el código de estado HTTP es 500. Un código de estado 500 es un código de error de entorno de ejecución común para las infracciones de la política de protección contra aumentos de tráfico.

5. Consulta la distribución por app de desarrollador, justo debajo del panel Causa sospechada, para identificar las apps de desarrollador con las tasas de error más altas.
   

Para obtener más información sobre este paso, consulta Identifica problemas.

Paso 4: Configura una alerta 5xx

Configura una alerta según el contexto seleccionado en el panel de detalles de Investigar para recibir una notificación cuando la cantidad de códigos de estado 5xx supere un umbral específico.

1. En el panel derecho del panel Investigar, selecciona > Crear alerta.

2. Completa los campos del diálogo de alerta. Los campos de condición se propagan previamente con datos del contexto actual. Por ejemplo:

   

3. Haz clic en Guardar.

En el futuro, cuando la tasa de error 5xx supere el 5% durante un período de 5 minutos para el proxy de API perfBenchmark_invalid_v1, se enviará una notificación al correo electrónico especificado y se mostrará una alerta visual en la IU. Por ejemplo:

Para obtener más información sobre este paso, consulta Configura alertas y notificaciones.

Paso 5: Genera un informe personalizado con detalles del cliente (opcional)

De manera opcional, genera un informe personalizado para identificar más detalles sobre el cliente que activa los errores 5xx.

En la página Informes, los informes personalizados que se crean en función de una alerta se nombran con el siguiente formato: API Monitoring Generated: alert-name.

1. Accede al informe personalizado que se creó cuando se configuró la alerta de una de las siguientes maneras:

   • Selecciona Analizar > Informes personalizados > Informes en la barra de navegación izquierda para mostrar la página Informes. Haz clic en el nombre del informe en la lista: API Monitoring Generated: 5xx Alert.

   • Haz clic en la notificación que se muestra cuando se crea la alerta. Por ejemplo:

   

2. Agrega las siguientes dimensiones:

   • App de desarrollador
   • ID de cliente
   • Dirección IP de cliente

   

3. Para ver un informe basado en una app de desarrollador específica con una tasa de error alta, agrega un filtro similar al siguiente:

   and (developer_app eq 'perfBenchmarkApp0')

   Nota: En este caso, quita App de desarrollador de la lista de dimensiones.

4. Haz clic en Guardar.

5. Ejecuta el informe para ver detalles sobre la app de desarrollador y los clientes que activan el código de estado 5xx.

Para obtener más información sobre este paso, consulta Crea informes personalizados.

Paso 6: Agrupa los proxies de API en una colección

Crea una colección para agrupar los proxies de API y configurar los valores de umbral de alerta adecuados para todos los miembros del grupo para diagnosticar problemas más rápido.

1. Selecciona Analizar > Supervisión de API > Colecciones en la IU de Edge para mostrar el panel Colecciones.
2. Haz clic en + Colección.
3. Selecciona Proxy.
4. Selecciona prod en el menú desplegable del entorno.
5. Haz clic en Siguiente.
6. Completa los campos del diálogo de colección.
   
7. Haz clic en Guardar.

A continuación, puedes configurar una alerta, similar al paso 4, y establecer la dimensión en la colección que definiste anteriormente.

Para obtener más información sobre este paso, consulta Administra colecciones.

Paso 7: Resuelve los problemas 5xx

Toma las medidas adecuadas para resolver los problemas 5xx. Por ejemplo, según tu diagnóstico, puedes realizar una de las siguientes tareas:

• Usa Apigee Sense para determinar si el aumento en las solicitudes es sospechoso y decide bloquear la dirección IP del cliente identificada en el informe personalizado.
• Agrega una política de cuotas para limitar la cantidad de conexiones que las apps de desarrollador pueden realizar en tu proxy de API durante un período específico.
• Monetiza tu API para cobrarles a los desarrolladores por el uso de una cierta cantidad de llamadas.