Health Check Endpoint

A health check endpoint is a lightweight URL that reports whether an application can serve traffic. It returns 200 when healthy and a non-2xx status, commonly 503, when not.

Why it matters

Load balancers, orchestrators and uptime monitors use it to decide where to route traffic and when to restart or alert. The design determines behavior. A shallow check (process is up) catches crashes. A deep check (database and cache reachable) catches dependency failures but can make every instance look unhealthy at once if a shared dependency blips.

Example

A minimal endpoint and a probe:

GET /healthz
200 OK
{"status":"ok","db":"ok"}

curl -fsS -m 3 https://example.com/healthz

The -f flag makes curl fail on HTTP errors and -m 3 sets a three-second limit. Keep the endpoint cheap, unauthenticated for the checker only, and fast enough to be called every few seconds.

Common mistakes

• Making the check so deep that a non-critical dependency outage removes all servers from rotation.
• Returning 200 with an error message in the body.
• Exposing sensitive diagnostics publicly.
• Checking only /, which may be served from cache while the app is broken.

Related

• Health check
• Readiness probe
• Liveness probe
• टूल: Uptime monitor

यह पेज सामान्य जानकारी है, जिसे हमारी संपादकीय टीम ने लिखा है और दस्तावेज़ीकरण बदलने पर अपडेट किया जाता है। सर्वर और प्रदाता अलग-अलग होते हैं, इसलिए बदलाव पहले सुरक्षित तरीके से जाँचें। देखें: संपादकीय नीति और अस्वीकरण.