spring-cloud/spring-cloud-netflix

Allow custom health check status mapping

Open

Aperta il 2 mar 2021

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Java (4805 star) (2433 fork)batch import
enhancementhelp wanted

Descrizione

With Spring Boot Actuator health check endpoint, we can use management.endpoint.health.status.http-mapping.<status> to map a custom status to an HTTP status code. But for Eureka integration, any custom status would map to UNKNOWN status in Eureka since the mapping is not configurable (https://github.com/spring-cloud/spring-cloud-netflix/blob/master/spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/eureka/EurekaHealthCheckHandler.java#L61-L64). It would be nice if we can map custom statuses to UP/DOWN/OUT_OF_SERVICE via properties similar to the health check endpoint HTTP status mapping.

Guida contributor

Tech stack
javaspring
Dominio
backendcloud
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
JavaSpring BootEurekaHealth check concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65
Direzione di ricerca
Investigate the implementation in EurekaHealthCheckHandler.java (line 61-64) where custom statuses are mapped to UNKNOWN. Study Spring Boot's approach to custom health status HTTP mapping via properties. Propose a configuration property similar to 'eureka.instance.health check status mapping.<status>' that allows mapping custom statuses to UP/DOWN/OUT OF SERVICE. Ensure backward compatibility.