liveBook · Manning

Health check

As explained in Machine Learning Platform Engineering

A diagnostic test that determines whether a service or execution unit is functioning and able to handle requests.

A health check is an endpoint-based diagnostic that reports whether a deployed service or pod is functioning and able to handle requests. In Kubernetes environments, it supports observability, pod management, and troubleshooting. section 10.4.1

Distinguish the related checks by the operational decision they support:

  • Liveness probes call /healthz periodically to determine whether the pod is alive and able to run its main process; failure may cause Kubernetes to restart it. section 10.4.1
  • Readiness probes call /readyz periodically to determine whether the pod is operational and ready to receive traffic. section 10.4.1
  • BentoML provides built-in health checks and liveness/readiness probe support, reducing the endpoint implementation required for a deployed service. section 10.4.1

Diagnosing a pod that will not initialize

Configure Kubernetes to inspect /healthz for liveness and /readyz for readiness. A failing /healthz indicates an initialization or process problem to investigate; a pod that is alive but not ready should not receive traffic. section 10.4.1

Figure 10.7 BentoML’s built-in observability endpoints for K8s environments
A screenshot of a computer

AI-generated content may be incorrect.

Inspect the BentoML observability endpoints supplied for Kubernetes environments. section 10.4.1

How Machine Learning Platform Engineering covers it

How deep it goes
Defines health, liveness, and readiness roles with endpoint behavior, but does not detail custom implementation code.
Examples
Uses /healthz and /readyz endpoints, pod initialization failures, BentoML services, and Kubernetes probe behavior.
What it assumes
Assumes familiarity with deployed services and pods while introducing health, liveness, and readiness distinctions.
What you can do after
Operate/configure deployed services with liveness and readiness monitoring in Kubernetes environments.
How it connects
Connects health checks with Kubernetes, liveness probes, readiness probes, observability, and Prometheus metrics.

Also explained in

Compare how 9 books explain health check →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Machine Learning Platform Engineering. The section links point to the parts of the book it draws on.