aboutcode-org / aboutcode-org/scancode.io

Health check endpoint

Abierto
#922 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
215
Forks
203
Merge medio
4 d 8 h
PR fusionados (30 d)
6

Descripción

Often in deployments, a health check endpoint is required for the CI/CD to ensure that the service has deployed properly. At least [aws requires it in load balancers][1].

In SCIO, any endpoint can serve as a healthcheck, for eg: `/api/?format=json` as long as it is running unauthenticated.
With authentication enabled, all endpoints will throw `401` without a token. There are two possible solutions:

1. Implement a `/healthcheck` endpoint in SCIO that gives 200 after checking basic db connection etc
2. Goto AWS -> Target Group (under load balancing) -> Health checks (tab) -> Edit -> Advanced health check settings -> Success codes -> add `401`

[1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/target-group-health-checks.html

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.