spring-cloud/spring-cloud-netflix

Allow custom health check status mapping

Open

#3,975 建立於 2021年3月2日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Java (4,805 star) (2,433 fork)batch import
enhancementhelp wanted

描述

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.

貢獻者指南

技術棧
javaspring
領域
backendcloud
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaSpring BootEurekaHealth check concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
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.