Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add Healthcheck route

Aperta
  • Qualcosa non va?
#27 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
mysql, python
Ambito
api, backend, databases

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.

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.

{
    "ldap": {
        "status": true,
        "server": "stone.csh.rit.edu"
    },
    "database": {
        "status": true,
        "server": "mysql.csh.rit.edu"
    }
}
Lingua principale
Python
Stelle
5
Fork
3
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ComputerScienceHouse/self-service

Tutte le issue di ComputerScienceHouse/self-service

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.