Monitoring RepoFlow

RepoFlow provides several API routes that users can use to monitor the system's health and ensure all critical services are running correctly.

Health Check API Routes

1. Basic Health Check

• Endpoint: GET /health
• Description: Returns a basic 200 OK response if the server is running.
• Response:

  HTTP 200 OK

2. Hasura Database Health Check

• Endpoint: GET /health/hasura
• Description: Checks if the connection to the Hasura GraphQL engine is active.
• Responses:

  HTTP 200 OK  // If Hasura is reachable
  HTTP 503 Service Unavailable  // If Hasura is down

3. Object Storage (S3) Health Check

• Endpoint: GET /health/object-storage
• Description: Verifies that the object storage (S3 or compatible) is accessible and functional.
• Responses:

  HTTP 200 OK  // If object storage is reachable
  HTTP 503 Service Unavailable  // If object storage is down

4. Full System Health Check

• Endpoint: GET /health/full
• Description: Runs a complete health check, verifying the status of Hasura and object storage.
• Responses:

  HTTP 200 OK
  {
    "hasura": true,
    "objectStorage": true
  }

  HTTP 503 Service Unavailable
  {
    "hasura": true,
    "objectStorage": false
  }