ComputerScienceHouse / ComputerScienceHouse/conditional

Add Healthcheck route

Aberta
#261 0 comentários 0 reações 0 responsáveis Ver no GitHub
good first issue
Linguagem predominante
Python
Estrelas
12
Forks
39
Merge médio
1d 13h
PRs com merge (30d)
1

Descrição

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

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Nenhum arquivo ou teste é indicado. Comece localizando a estrutura de rotas Flask existente e os pontos de entrada das conexões LDAP e MySQL; em seguida, implemente o comportamento especificado de GET /api/v1/healthcheck; considera-se concluído quando as respostas JSON não autenticadas distinguirem entre estado saudável, falhas somente de LDAP, falhas somente do banco de dados e falhas combinadas com os intervalos de status solicitados.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
flask, mysql, python
Domínio
api, backend, observability
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.