spring-cloud/spring-cloud-netflix

Allow custom health check status mapping

Open

#3975 opened on Mar 2, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (4,805 stars) (2,433 forks)batch import
enhancementhelp wanted

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaSpring BootEurekaHealth check concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.