Health Checks
BugPin exposes a health endpoint that answers without authentication. Use it to check that the server is up after an installation or upgrade, and as the target for Docker, load balancer, and uptime monitoring checks.
Health Endpoint
curl https://bugpin.example.com/health
Response:
{
"success": true,
"status": "healthy",
"timestamp": "2024-01-06T12:00:00.000Z",
"version": "1.0.0"
}
version is the BugPin version that is running, which makes the endpoint a quick way to confirm an upgrade.
On the server itself, call the port directly:
curl http://localhost:7300/health
Docker
The docker-compose.yml from the Docker installation defines a health check that calls the endpoint every 30 seconds. Read the result with:
docker inspect --format='{{.State.Health.Status}}' bugpin
docker compose ps shows the same state in its status column.
Load Balancers and Uptime Monitors
Point the check at /health and treat any response other than HTTP 200 as down. Behind a reverse proxy, check the public address so the proxy and certificate are covered as well.