Analice una situación de muestra

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Analiza una situación de ejemplo en la que se demuestra cómo solucionar problemas 5xx de tus APIs.

#	Step	Descripción
1	Supervisa el tráfico reciente de la API	Consulta los datos recientes de supervisión de API para todos los proxies y destinos de API que tuvieron tráfico en la última hora. Desglosa los proxies o los destinos de las APIs con una tasa de porcentaje de errores alta.
2	Identifica tendencias en tus datos de supervisión de APIs	Accede a una vista histórica de tus datos de supervisión de APIs de los últimos 3 meses para obtener una perspectiva más amplia.
3	Investiga 5xx problemas	Consulta los códigos de fallas que experimentan los volúmenes relativos más altos a lo largo del tiempo para investigar con más detalle la fuente de los problemas de tipo 5xx. Por lo general, los códigos de estado 5xx se pueden clasificar mediante uno o más códigos de falla.
4	Configura una alerta 5xx	Configura una alerta para recibir notificaciones cuando la cantidad de códigos de estado 5xx supere un umbral en particular.
5	Genera un informe personalizado con los detalles del cliente (opcional)	De manera opcional, genera un informe personalizado para identificar los detalles del cliente que activa los errores 5xx. Nota: Debes ser un administrador de la organización para generar un informe personalizado.
6	Agrupa proxies de API en una colección	Crea una colección a fin de agrupar los proxies de API y configura los valores de umbral de alerta adecuados para todos los miembros del grupo y, así, 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 relacionados con el formulario 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 los destinos de API que tuvieron tráfico en la última hora, sigue estos pasos:

1. Selecciona Analyze > API Monitoring > Recent en la IU de Edge para acceder al panel Recientes.

2. Observa los proxies y destinos de la API que tuvieron una tasa de error de porcentaje alta durante la última hora.
   

3. Haz clic en el proxy de API o en el destino con un porcentaje de error 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 Cómo supervisar el tráfico reciente de la API.

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

Para acceder a una vista histórica de los datos de supervisión de APIs correspondientes a los proxies y destinos de las APIs que tuvieron tráfico en los últimos tres meses, sigue estos pasos:

1. En el panel derecho del panel Recientes, selecciona > Ver en cronograma para acceder al panel de Rutas. También puedes hacer clic en Analyze > API Monitoring > Timeline en la IU de Edge.
   
2. Observa la tendencia del proxy o objetivo de la API a lo largo del tiempo. Observa que la tendencia se mantuvo coherente durante los últimos 7 días.

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

Paso 3: Investiga los problemas 5xx

Apigee proporciona un conjunto de códigos de fallas 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 problemas 5xx, haz lo siguiente:

1. En el panel derecho del panel Timeline, selecciona > View in Investigate para acceder al panel Investigate. Como alternativa, puedes hacer clic en Analizar > Supervisión de API > Investigar en la IU de Edge.
   
   El panel Investigate te permite comparar la actividad relacional entre métricas, como el código de fallas en comparación con el tiempo.

2. Consulta el código de fallas frente a la matriz de tiempo para ver la actividad del código de fallas durante la última hora. Observa los códigos de fallas 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, más alto 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. Ten en cuenta 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 los incumplimientos de la política de Spike Arrest.

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

Para obtener más información sobre este paso, consulta Cómo identificar problemas.

Paso 4: Configura la alerta 5xx

Configura una alerta basada en el contexto seleccionado en el panel Investigar detalles 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 prepropagan 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 envía una notificación al correo electrónico especificado y se muestra 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 los 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 usan el siguiente formato: API Monitoring Generated: alert-name.

1. Puedes acceder al informe personalizado que creaste cuando configuraste la alerta de una de las siguientes maneras:

   • Selecciona Analyze > Custom Reports > Reports en la barra de navegación izquierda para ver 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 la opción App de desarrollador de la lista de dimensiones.

4. Haz clic en Guardar.

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

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

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

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

1. Selecciona Analyze > API Monitoring > Collections en la IU de Edge para mostrar el panel Collection.
2. Haz clic en + Colección.
3. Selecciona Proxy.
4. Selecciona la opción prod del menú desplegable del entorno.
5. Haz clic en Siguiente.
6. Completa los campos en el diálogo de la 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 Cómo administrar colecciones.

Paso 7: Resuelve los problemas del tipo 5xx

Toma las medidas adecuadas para resolver los problemas relacionados con los formularios 5xx. Por ejemplo, según el diagnóstico, podrías realizar una de las siguientes tareas:

• Utiliza Apigee Sense para determinar si el aumento repentino de solicitudes es sospechoso y decide que quieres 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 pueden hacer las apps de desarrollador a 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.