liveBook · Manning

Health check endpoint

As explained in Logs and Telemetry

A health endpoint is an HTTP endpoint that reports whether an application or service is operating normally.

A health check endpoint is an HTTP endpoint that reports whether an application or service is operating normally. In containerized and Kubernetes environments, it lets orchestration systems detect unhealthy instances instead of treating silence as success. section 2.6

Health checks connect application behavior to deployment automation:

  • Return an HTTP status from the 200–299 range for a healthy response; other status codes are treated as unhealthy. section 2.6
  • Support Docker health checks and Kubernetes probes, including liveness checks that can trigger Pod replacement. section 2.6
  • Expose a web server and configure its listener, port, health-check switch, retry counts, and polling period. section 2.6

Querying Fluent Bit

With Fluent Bit's HTTP server and health checks enabled, query the health endpoint with curl at 0.0.0.0:2020/api/v1/health. section 2.6

How Logs and Telemetry covers it

How deep it goes
Defines status semantics and Fluent Bit configuration, but does not detail response bodies beyond an optional ok value.
Examples
Uses the conventional /health path, a localhost health URL, Fluent Bit configuration, and curl requests.
What it assumes
Explains Dockerfiles, Pods, probes, and HTTP status expectations without requiring a separate prerequisite concept.
What you can do after
Operate/configure Fluent Bit to expose and query an HTTP health endpoint for container or Pod checks.
How it connects
Links health endpoints with observability, Docker health checks, Kubernetes probes, liveness checks, and Fluent Bit.
Cover of Logs and Telemetry
liveBookmanning.com
Read Logs and Telemetry on liveBook Get the book at manning.com

Also explained in

Compare how 5 books explain health check endpoint →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Logs and Telemetry. The section links point to the parts of the book it draws on.