[Discussion] Health Check Endpoint

[Flouse]

• [ ] discuss how to implement a health check feature for assets API
  • [ ] Dependent Service Checks

Example

{
  "status": "healthy" | "degraded" | "unhealthy",
  "checks": [
    {
      "name": "API Availability",
      "status": "healthy",
      "description": "API is responding with 200 OK"
    },
    {
      "name": "Queue function",
      "status": "healthy", 
      "description": "...."
    }
  ]
}

References

• https://upptime.js.org/docs/ Upptime is a free and open-source uptime monitor and status website service. It's very different from other status-page services because it doesn't require a server — it's all powered by GitHub
  • https://demo.upptime.js.org/

[ahonn]

Using upptime we need to consider:

• Quota for GitHub Actions: https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#about-billing-for-github-actions
• Github Pages needs to be enabled under the organization

[ahonn]

I added /healthcheck on the feat/healthcheck branch to perform health checks and return status. It can be viewed by visiting: https://btc-assets-api-healthcheck.vercel.app/healthcheck.

And created an upptime example: https://github.com/ahonn/upptime, used the above /healthcheck to obtain the status of dependent services and applications. But here it is through a single API, so Response Time has no meaning.

I'm not sure if we need to split different services or application status into separate APIs, such as /healthcheck/electrs, /healthcheck/queue ?

[Flouse]

I'm not sure if we need to split different services or application status into separate APIs, such as /healthcheck/electrs, /healthcheck/queue ?

I think one API is good enough.