Revisión de funcionalidades ofrecidas por X-Ray

[milo19980525]

Se requiere revisar la documentación acerca de servicios o funcionalidades ofrecidas por X-Ray.

Especificaciones técnicas

• El último desarrollo relacionado con la implementación de X-Ray se encuentra en release para ambas APIs.

Sub Tareas

• [x] Averiguar acerca de los canaries en X-Ray e implementarla en por lo menos un segmento comprobando su funcionamiento.
• [x] Investigar y presentar diversas soluciones para actualizar gráfico de X-Ray de manera automatizada sin darle el botón ejecutar, o averiguar actualmente cada cuanto se actualiza.
• [x] Documentar y presentar soluciones para la implementación sobre el servicio de notificaciones cuando un fallo se presente. ¿Con que otros servicios se puede intercomunicar?

Criterios de aceptación

• [x] Se realiza la invesitgación pertinente a cada uno de los puntos y se documenta en el issue.
• [x] Se averigua sobre los canaries y se realiza su respectiva implementación con uno de los servicios. Se documenta en el issue la respectiva prueba de concepto.

Requerimientos

• [x] Acceso total a servicio X-Ray y su complemento en CloudWatch en AWS.

Dependencias

• No presenta.

Definition of Ready - DoR

• [x] Está refinada y estimada en puntos de historia por el equipo.
• [x] Incluye la descripción y criterios de aceptación, con el detalle funcional y especificaciones técnicas, de forma entendible por cualquier miembro del equipo.
• [x] No tiene bloqueos que impidan su ejecución.
• [x] Las dependencias entán identificadas y resueltas.
• [x] Puede ser probada dentro del Sprint.

Definition of Done - DoD - Desarrollo

• [x] Desarrollo en local.
• [x] Push en Feature.
• [x] Pruebas locales (funcionales).
• [x] PR a Develop.
• [x] Criterios de aceptación cumplidos.
• [x] Documentación de issue realizada.
• [x] Aprobada por SM/Líder técnico.

[a52290451]

Canaries:

Las "Canaries" en AWS X-Ray son una forma de realizar pruebas de integración y detección temprana de problemas en tus aplicaciones y servicios. En el contexto de X-Ray, una "Canary" es una pequeña carga de trabajo o traza simulada que se envía a través de tu sistema para verificar la salud, el rendimiento y la detección de problemas. Estas pruebas pueden ayudarte a garantizar que tu sistema esté funcionando correctamente y a identificar cualquier problema antes de que afecte a los usuarios reales.

• AWS presenta la opción "Canaries de Synthetics" en CloudWatch para crear canaries con base en una serie de configuraciones predeterminadas. También permite crear canaries a partir de scripts, lo cual brinda un mayor rango de personalización del canary. Con esto, es posible probar diferentes funcionalidades y partes de una API, para verificar su estado y diferentes métricas adicionales.

[a52290451]

Actualizar Mapa de Servicios de AWS X-Ray de forma automatizada:

1. De forma predeterminada, el mapa de servicios se actualiza cada 5 min. Sin embargo, existe la opción para ajustar esta medida de tiempo:

2. El límite máximo de actualización del Mapa de Servicios es de 10 Segundos.
3. La actualización del mapa de servicios se encuentra enlazado con la consulta de trazas, por lo que no es necesario realizar algún ajuste adicional.

[a52290451]

Se realiza optimización de la implementación de AWS X-Ray en las APIs para mostrar el código de respuesta final en el segmento principal de la traza:

Se implementan diferentes funciones que permiten inicializar los segmentos de cada traza con la inicialización de XRAY, y finalizarlos dependiendo de si hay una respuesta correcta de la petición o si ha ocurrido algún error. Además, se actualiza el estado del segmento desde el archivo "utilidades" de cada API:

Con estos ajustes, se realiza un seguimiento mas detallado del estado en el cual se finalizan las peticiones entrantes a cada API.

[a52290451]

Actualización:

Se realiza la instrumentación de código en APIs, para actualización automática del estado de las solicitudes entrantes y salientes.

En el archivo "utils_oas/xray/xray.go" se implementan las siguientes funciones de control y actualización del estado de los segmentos que se envían a AWS-XRay:

De esta forma se controla el cambio de estado en cada situación que se presente.

En Las APIs MID, fue necesario ajustar el archivo "utilidades" de la siguiente forma:

Después de realizar la solicitud de información a otras APIs, se actualiza el estado del segmento dependiendo de la respuesta obtenida, que puede ser un error o una consulta satisfactoria.

También se modifica la función "ErrorController", presente en todos los controladores:

En este caso, se actualiza el estado del segmento, según el estado de la solicitud y se realiza el cierre del segmento con error.

Observaciones:

1. Se requiere realizar una evaluación de coherencia de respuestas de solicitudes de APIs. En el caso de "cumplidos_dve_mid" algunas solicitudes en las cuales el código de respuesta debe ser 500, aparecen como 200.
2. Revisar implementación de GetRequestNew y funciones derivadas en el archivo "utilidades", cuando un endpoint no responde, no se realiza un manejo adecuado del error.
3. El error 404, no se puede capturar en los segmentos ya que su causa es a raíz de no encontrar el servicio señalado para el API en cuestión. Se debe buscar una forma de identificarlo sin alterar el código fuente de las APIs.

[a52290451]

La implementación de Alarmas se señala en: https://github.com/udistrital/autenticacion_mid/issues/76

[a52290451]

Para la implementación de Canaries se debe tener en cuenta lo siguiente:

Al crear un canary, se crean los siguientes recursos para el mismo:

1. Un rol de IAM con el nombre CloudWatchSyntheticsRole-canary-name-uuid (si usa la CloudWatch consola para crear el canario y especifica que se cree un nuevo rol para el canario)

2. Una política de IAM con el nombre CloudWatchSyntheticsPolicy-canary-name-uuid.

3. Un bucket de S3 con el nombre cw-syn-results-accountID-region.

4. Alarmas con el nombre Synthetics-Alarm-MyCanaryName, si desea que se creen alarmas para el canary.

Por tal razón se debe tener permisos para su creación. Los canarios ejecutan una serie de acciones sobre determinados enlaces, pueden servir para:

1. Monitoreo de latidos.
2. Canary de API.
3. Verificador de enlaces que no funcionan.
4. Proyecto de monitoreo visual.
5. Registrador de canaries.
6. Generador de flujo de trabajo de la GUI.

Estos proyecto se encuentran predeterminados y pueden ser seleccionados, sin embargo, se pueden codificar otro tipo de canarios para tareas especificas, mediante scripts.