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

feature: Add health check endpoint #24

Open
matthiasschoger opened this issue Jan 30, 2024 · 1 comment
Open

feature: Add health check endpoint #24

matthiasschoger opened this issue Jan 30, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@matthiasschoger
Copy link

matthiasschoger commented Jan 30, 2024

First of all, great project! This enhancement request should be pretty easy to implement.

For added resiliency, add a health check endpoint to validate that the updater is actually running.
Proposed endpoints could be /health or /alive, with a simple HTTP 200 as the response code. Maybe add an "ok" in the body.

Bonus points: A JSON response which lists if the last communication attempts to the Fritz!Box and Cloudflare were successful. Still keep the 200 response code, even if these connections were not successful.

@cromefire
Copy link
Owner

cromefire commented Jan 30, 2024

Would definitely take a PR, not sure when I have time to implement that, pretty busy right now... Ideally it'd also expose some Prometheus metrics with failures and such I think so you can set up alerting

@cromefire cromefire changed the title IMPROVEMENT: Add health check endpoint feature: Add health check endpoint Jan 30, 2024
@cromefire cromefire added the enhancement New feature or request label Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants