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

Health check endpoint #1

Closed
longngn opened this issue Feb 27, 2022 · 1 comment
Closed

Health check endpoint #1

longngn opened this issue Feb 27, 2022 · 1 comment

Comments

@longngn
Copy link

longngn commented Feb 27, 2022

Describe your idea, in simple words.

Many infra management tools like K8s rely on a health check endpoint of service to schedule restart or do alerting. I guess we can GET /v1/checkpoints but not sure if that's hacky.

Why is it a good idea?

It'll be more compatible with existing infrastructures. Ogmios also has a /health endpoint.

Are you willing to work on it yourself?

I haven't dug much into the codebase to understand what should be considered healthy for Kupo.

@KtorZ
Copy link
Member

KtorZ commented Feb 27, 2022

The GET /v1/checkpoints isn't hacky at all, it's meant to monitor the progress of the underlying syncing process. However, that's more about progress reporting than about health.

I agree that a health endpoint (and command, for containers) would be nice also.

@KtorZ KtorZ closed this as completed in 431c196 Mar 5, 2022
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

No branches or pull requests

2 participants