spring-cloud/spring-cloud-netflix

Allow custom health check status mapping

Open

#3.975 geöffnet am 2. März 2021

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (4.805 Stars) (2.433 Forks)batch import
enhancementhelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javaspring
Domain
backendcloud
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaSpring BootEurekaHealth check concepts
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
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.