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 #4521

Open
1 task done
tim-van-dijkhuizen opened this issue Nov 3, 2022 · 2 comments
Open
1 task done

Health check endpoint #4521

tim-van-dijkhuizen opened this issue Nov 3, 2022 · 2 comments
Labels
feature request A request for a new feature.

Comments

@tim-van-dijkhuizen
Copy link
Contributor

tim-van-dijkhuizen commented Nov 3, 2022

Is there an existing feature request for this?

  • I have searched the existing issues before opening this feature request.

Describe the feature you would like to see.

Please add a /health endpoint to the panel and wings.

Describe the solution you'd like.

A HTTP endpoint that does not require authentication and just returns a blank status 200 page if the system is working correctly.

Additional context to this request.

Example usage: Let Docker automatically restart the container if the app or its SSL certificate stops working.

@tim-van-dijkhuizen tim-van-dijkhuizen added the feature request A request for a new feature. label Nov 3, 2022
@Boy132
Copy link
Contributor

Boy132 commented Dec 4, 2023

How about something like spatie/laravel-health?
This allows to add more detailed health checks and could be implemented fairly easy. It supports both a http endpoint to display the results in a user friendly ui and a json endpoint for the api. (which would return a simple 200 with the check results as response body) It also allows to create custom checks, e.g. checking wings health or server specific health aspects like checking for failed backups or installs.

Thoughts @matthewpi ?

@Telokis
Copy link

Telokis commented Aug 11, 2024

Hello! I'm trying to create a nice and generic docker-compose.yml including both panel and wings so we can easily deploy Pterodactyl with Coolify.
As part of this work, I'd like to add healthchecks for both services.

For panel it's quite easy, I add it to my docker-compose.yml like so:

    healthcheck:
      test: ["CMD-SHELL", "curl -sf http://localhost:80 || exit 1"]
      interval: 10s
      timeout: 1s
      retries: 3

and it works as expected.

But for wings, it's currently impossible because the base image is distroless. (See this and this).

The main issue is that we don't have access to any kind of binary that could perform the healthcheck query for us. (curl or wget).

Exposing a /healthcheck endpoint would not solve this issue but I think it's quite close to this issue so I didn't want to create a new one unless asked to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request A request for a new feature.
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants