temporalio / temporalio/sdk-java
Add HealthIndicator to spring-boot library
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 433
- Forks
- 249
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 26
Description
Is your feature request related to a problem? Please describe.
I would like to monitor the state of Temporal Java SDK and workers through spring-boot-actuator's /health endpoint
Describe the solution you'd like
In the temporal-spring-boot-autoconfigure-alpha project, create a HealthIndicator and AutoConfiguration that includes information on the connection, state of the workers, and anything else that could be of value for health.
Could use RabbitHealthIndicator and RabbitHealthContributorAutoConfiguration as an starting point.
Describe alternatives you've considered
Split monitoring health of workers and temporal connection into separate health indicators
Additional context
HealthIndicator allows external monitoring tools to check whether the application has entered a failed state and needs a restart.
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 in the temporal-spring-boot-autoconfigure-alpha project and compare RabbitHealthIndicator with RabbitHealthContributorAutoConfiguration in Spring Boot Actuator. Identify the existing connection and worker APIs before deciding what health details they expose. Done means the auto-configuration provides an Actuator health contributor that reports the requested Temporal connection and worker state.
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