AddThisFeature

Health Check Endpoint

Tell your platform whether the app is actually alive.

simple Developer Experience

What it adds

A health endpoint your host, load balancer, or uptime monitor can poll.

What your agent is told to do

4
  1. 1

    Expose a simple endpoint that returns 200 when the app can serve traffic.

  2. 2

    Distinguish LIVENESS (the process is up) from READINESS (dependencies are reachable). They deserve different endpoints.

  3. 3

    Keep it cheap. It gets hit constantly; it must not run an expensive query.

  4. 4

    Exclude it from authentication and from any HTTPS redirect — the platform's internal probe uses plain HTTP and won't follow a 301.

Edge cases it handles

4
  • The endpoint must not leak version numbers, dependency details, or config to the public internet.
  • A dependency being slow must not make the health check hang — set a timeout.
  • Do not fail liveness because a non-critical dependency is down, or your platform will restart-loop a healthy app.
  • Exclude it from analytics and error reporting, or it will flood both.

Definition of done

8
  • The endpoint returns 200 when the app can serve traffic.
  • Liveness and readiness are distinguished.
  • It is cheap and has timeouts on any dependency check.
  • It bypasses auth and HTTPS redirects.
  • It leaks no internal detail publicly.
  • It is excluded from analytics and error reporting.
  • The feature matches the existing design system.
  • No existing functionality is broken.

Related features

How it works

  1. 1

    Copy the link

    Grab the Markdown instruction URL for this feature.

  2. 2

    Give it to your AI

    Paste it into Claude Code, Cursor, v0, Lovable — whatever you build with.

  3. 3

    It inspects, then implements

    Your agent reads your existing app first, then adds the feature to fit it.

Works with your stack

These instructions are written to adapt. They tell the agent to detect your framework, match your existing design system, and reuse what you already have — rather than assuming a particular stack.

Need it tighter than that? Customize the feature and tell it exactly what you're running.