Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support a configurable readiness check endpoint via http #42

Merged
merged 3 commits into from
Feb 10, 2025

Conversation

ShuranZhang
Copy link
Collaborator

@ShuranZhang ShuranZhang commented Feb 8, 2025

Expose a new string config ReadinessCheckEndpointinconfig.yaml`.
This endpoint is used for monitoring purposes to verify if all configured listeners are successfully started and running.

  • To check the status, you need to query the /debug/health path of this endpoint
  • It will return an HTTP 200 OK status if all listeners are up and running.
  • If not all listeners are ready, it returns HTTP 503 Service Unavailable.
  • If this option is not set, the readiness check HTTP endpoint
    will not be registered and no readiness checks will be available via HTTP.

Example output when I setReadinessCheckEndpoint:localhost:8080 in my local experiment:
7n8QHapGUKKnPk6

It's a good idea to open an issue first for discussion.

  • Tests pass
  • Appropriate changes to documentation are included in the PR

@mayurkale22 mayurkale22 merged commit fbce0f7 into cloudspannerecosystem:main Feb 10, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants