Skip to content

Advanced Health Check Endpoint #80

Description

@nursetechie

Issue #40 — feat: Advanced Health Check Endpoint

Description

The basic /health endpoint is insufficient for Kubernetes readiness probes, as it returns success even if the database is down. An advanced health check validates downstream dependencies, preventing traffic from routing to broken instances.


Requirements & Context

Architectural Goal: Enable accurate container orchestration readiness probes.

Implementation Expectations: Update the /health endpoint to query the Prisma database connection and the Stellar RPC node. Return an HTTP 503 if any critical dependency is offline.


Acceptance Criteria

  • The endpoint accurately reflects the health of external dependencies.
  • HTTP status codes accurately distinguish between healthy (200) and degraded (503) states.

Out of Scope

  • Implementing complex retries for the health check itself.

Suggested Execution

git checkout -b feat/advanced-health-check

Suggested Commit Message

feat: implement advanced health check verifying database and rpc connectivity

Testing Notes

  • Turn off the local PostgreSQL database and verify the endpoint responds with a 503 HTTP code.

References

Kubernetes Liveness and Readiness Probe best practices.


Definition of Done

  • Ready for review.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions