Add Healthcheck route

Abierto
#261 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
flask, mysql, python
Área
api, backend, observability

Línea de trabajo

No se nombran archivos ni pruebas. Empieza por localizar la estructura de rutas existente de Flask y los puntos de entrada de las conexiones LDAP y MySQL, y después implementa el comportamiento especificado de GET /api/v1/healthcheck; se considera terminado cuando las respuestas JSON no autenticadas distinguen entre un estado saludable, fallos únicamente de LDAP, fallos únicamente de la base de datos y fallos combinados con los rangos de estado solicitados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

good first issue

This is a route that connects to the database, connects to ldap, and returns a json blob stating whether or not it can connect.

This should allow us to more reasonably monitor on whether or not conditional is in working order. The route should not be behind auth so datadog can hit it

How I want this to work

GET /api/v1/healthcheck

That would return 200 only when both ldap and the database connect correctly, and a 5XX range response when they don't. Different 5XX code for ldap down, sql down and both down. Return the json no matter what the status code is.

{
    "ldap": {
        "status": true,
        "server": "stone.csh.rit.edu"
    },
    "database": {
        "status": true,
        "server": "mysql.csh.rit.edu"
    }
}
Lenguaje dominante
Python
Estrellas
12
Forks
40
Merge medio
1 d 13 h
PR fusionados (30 d)
1

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ComputerScienceHouse/conditional

Todos los issues de ComputerScienceHouse/conditional

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.