ComputerScienceHouse / ComputerScienceHouse/self-service
Add Healthcheck route
- Lingua principale
- Python
- Stelle
- 5
- Fork
- 3
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
```json
{
"ldap": {
"status": true,
"server": "stone.csh.rit.edu"
},
"database": {
"status": true,
"server": "mysql.csh.rit.edu"
}
}
```
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Inizia individuando la registrazione della route API per GET /api/v1/healthcheck e i punti di ingresso esistenti per le connessioni LDAP e al database. Verifica che l’endpoint non autenticato restituisca JSON per i casi di stato sano, di solo LDAP non funzionante, di solo database non funzionante e di errore combinato, con 200 quando tutto è operativo e risposte 5XX distinte negli altri casi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- mysql, python
- Ambito
- api, backend, databases
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100