Skip to content

task/WG-371: improve status health check endpoint - #291

Merged
nathanfranklin merged 7 commits into
mainfrom
task/WG-371-improve-status-healthcheck
Jul 15, 2026
Merged

task/WG-371: improve status health check endpoint#291
nathanfranklin merged 7 commits into
mainfrom
task/WG-371-improve-status-healthcheck

Conversation

@nathanfranklin

Copy link
Copy Markdown
Collaborator

Overview

Adds an authenticated /status/complete endpoint to validate worker, Redis, and DB connectivity from within the worker network. Returns 200 if all components are healthy, 503 if any fail. This will be used in Gatus monitoring. This is primarily to address firewall issues on deployed VMs where workers cannot reach a needed resource (like redis or database). So to catch things like the recentn firewall issue where users cannot reach Redis on the geoapi-services machine

Related Jira tickets

Summary of Changes

  • Add /status/complete authenticated endpoint that submits a Celery task checking Redis and DB connectivity from the worker network
  • Health check task submitted at max priority to avoid being blocked by queued default tasks. So when high load for our default queue this could also trigger but for the time-being this should help us.

Testing Steps

  1. Start geoapi locally (make start)
  2. Log in to Hazmapper at http://localhost:8888
  3. Navigate to http://localhost:8000/status/complete/ — should return {"overall":"ok","components":{"redis":{"status":"ok","detail":null},"database":{"status":"ok","detail":null}}}

Notes

  • This endpoint is intended for use in Gatus monitoring of deployed services. I'll add there next.

The endpoint submits a Celery task to validate worker, Redis, and DB connectivity from within the worker network

@taoteg taoteg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! More monitoring FTW!

@nathanfranklin
nathanfranklin merged commit f1a48ef into main Jul 15, 2026
3 checks passed
@nathanfranklin
nathanfranklin deleted the task/WG-371-improve-status-healthcheck branch July 15, 2026 21:38
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.

3 participants