Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add Healthcheck route

Abierto
#43 1 comentario 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
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
mysql, python
Área
api, backend, databases, infrastructure

Línea de trabajo

Empieza localizando el punto de entrada de la API para GET /api/v1/healthcheck y las rutas de conexión existentes para la base de datos, LDAP y Proxmox. Se considera terminado cuando una respuesta JSON no autenticada informa sobre cada servicio, devuelve 200 solo cuando LDAP y la base de datos se conectan, y utiliza respuestas 5XX distintas cuando falla LDAP, la base de datos o ambos.

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

Descripción

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

This should allow us to more reasonably monitor on whether or not proxtstar 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"
    },
    "proxmox": {
        "status": true
    },
}
Lenguaje dominante
Python
Estrellas
31
Forks
25
Merge medio
3 h 59 min
PR fusionados (30 d)
2

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/proxstar

Todos los issues de ComputerScienceHouse/proxstar

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.