spring-cloud / spring-cloud/spring-cloud-config
/actuator/health/configServer indicator not useful since it uses local git cache
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2k
- Forks
- 1.3k
- Avg merge
- 2d 59m
- Merged PRs (30d)
- 16
Description
The /actuator/health/configServer endpoint always returns UP so long as the local git cache contains a repo for the application used for the health check. This would be okay if the ConfigServer serves only one client app.
However, when it serves multiple clients, it's not helpful. So, if it has local git cache for the health-indicator app, then it always returns UP even when git server is down. But if a different app is requested and git server is down, that other app will receive a 404. Yet the config server reports as UP, so load balancers won't take it out of the pool. (On the other hand, taking it out of the pool would cause clients to try the next URL if they are configured with multiple URLs.)
Can this health indicator be updated to report the health without relying on local git cache? To keep current behavior, perhaps make it configurable whether or not it uses local git cache during health check?
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 at the /actuator/health/configServer entry point and trace how the health check uses the local git cache. Define and verify behavior when multiple clients are served and the git server is unavailable; done means the reported health accurately reflects that situation while any retained local-cache behavior is configurable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, java, spring
- Domain
- backend, cloud, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100