ComputerScienceHouse / ComputerScienceHouse/packet
Add Healthcheck Route
- Langage dominant
- Python
- Étoiles
- 25
- Forks
- 33
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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 packet is up
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
```json
{
"ldap": true,
"database": true
}
```
Return the json no matter what the status code is.
Even better would be
```json
{
"ldap": {
"status": true,
"server": "stone.csh.rit.edu"
},
"database": {
"status": true,
"server": "mysql.csh.rit.edu"
},
}
```
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par localiser l’enregistrement des routes Flask ainsi que les helpers existants pour les connexions à la base de données et LDAP. Ajoutez GET /api/v1/healthcheck, avec du JSON renvoyé pour chaque résultat, des réponses 5XX distinctes lorsque LDAP, la base de données ou les deux sont en panne, et vérifiez que la réponse saine signale les deux dépendances.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- flask, mysql, python, sqlalchemy
- Domaine
- api, backend, databases, security
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100