ComputerScienceHouse / ComputerScienceHouse/conditional

Add Healthcheck route

Offen
#261 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
good first issue
Vorherrschende Sprache
Python
Sterne
12
Forks
39
Ø Merge
1 T. 13 Std.
Gemergte PRs (30 T.)
1

Beschreibung

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"
}
}
```

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Es werden keine Dateien oder Tests genannt. Beginne damit, die bestehende Flask-Routenstruktur sowie die Einstiegspunkte für LDAP- und MySQL-Verbindungen zu lokalisieren, und implementiere dann das spezifizierte Verhalten von GET /api/v1/healthcheck; als abgeschlossen gilt die Aufgabe, wenn nicht authentifizierte JSON-Antworten gesunde Zustände sowie reine LDAP-, reine Datenbank- und kombinierte Fehler mit den angeforderten Statusbereichen unterscheiden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
flask, mysql, python
Bereich
api, backend, observability
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.