spring-projects / spring-projects/spring-boot
Provide more information, such as the bean name, in health check failure messages
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 81.5k
- Forks
- 42.7k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 65
Description
https://github.com/spring-projects/spring-boot/pull/19684 raised an interesting requirement to provide more information in health check failure messages. The specific goal there was to include the name of the bean for which the health check has failed. This would help to pinpoint the problem in applications with multiple beans of the same type that are all being health-checked.
This issue is to track adding support for the above requirement in a more general-purpose manner. We may be able to make use of the existing constructor that takes a Function<Exception, String> to produce the error message.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing pull request #19684 and tracing the existing constructor that accepts a Function<Exception, String>. Determine how health check failures are created and where the bean name can be supplied. Done means the general-purpose failure message support includes the relevant bean name and existing health check behavior remains covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- backend, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100