spring-projects / spring-projects/spring-boot

Move health indicator logging from indicators to a central location

Open
#43,589 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: pending-design-work type: enhancement
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

See #43492 for background.

We'd like to centralize the logging when a health indicator fails so that it can be changed easily. This will involve:

  • Removing the existing logging from AbstractHealthIndicator and AbstractReactiveHealthIndicator (the logExceptionIfPresent method).
  • Updating Health so that the exception can be obtained.
  • Centralizing logging to the code the calls the health indicators.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read #43492 first for the background, then inspect AbstractHealthIndicator and AbstractReactiveHealthIndicator, especially logExceptionIfPresent. Trace the code that calls the health indicators and review Health to determine how the exception is exposed. Done means logging is removed from both indicator classes and centralized at the caller.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
backend, observability
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.