Add Healthcheck route

Ouverte
#261 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
45/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
flask, mysql, python
Domaine
api, backend, observability

Piste de recherche

Aucun fichier ni test n’est nommé. Commencez par localiser la structure de routage Flask existante ainsi que les points d’entrée des connexions LDAP et MySQL, puis implémentez le comportement spécifié de GET /api/v1/healthcheck ; le travail est considéré comme terminé lorsque des réponses JSON non authentifiées distinguent un état sain, les échecs LDAP uniquement, les échecs de base de données uniquement et les échecs combinés avec les plages de statuts demandées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

good first issue

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"
    }
}
Langage dominant
Python
Étoiles
12
Forks
40
Merge moyen
1 j 13 h
PR mergées (30 j)
1

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ComputerScienceHouse/conditional

Toutes les issues de ComputerScienceHouse/conditional

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.