liveBook · Manning

Health status

As explained in Spring in Action, Sixth Edition

A health status is a categorical representation of whether an application or external system is available and operational.

A health status categorizes whether an application or an external system is available and operational. Spring Boot Actuator exposes the application’s aggregate status through the health endpoint. section 15.2.1

Health indicators report the condition of systems the application depends on:

  • UP means the system is available and reachable. section 15.2.1
  • DOWN means the system is unavailable or unreachable. section 15.2.1
  • OUT_OF_SERVICE means the system is reachable but currently unavailable; UNKNOWN means its condition is unclear. section 15.2.1
  • The aggregate is UP when every indicator is UP, DOWN when any indicator is DOWN, and OUT_OF_SERVICE when any indicator has that status; UNKNOWN indicators are ignored. section 15.2.1
$ curl localhost:8080/actuator/health
{"status":"UP"}

Querying the Actuator health endpoint returns a compact JSON status such as {"status":"UP"}. Configure health details to inspect indicator results and diagnostic information. section 15.2.1

How Spring in Action, Sixth Edition covers it

How deep it goes
Defines four indicator states and aggregation rules, then demonstrates endpoint output without detailing indicator implementation.
Examples
Shows curl output with UP status and expanded JSON details for MongoDB and disk space.
What you can do after
Operate Spring Boot Actuator to query overall health and configure detailed indicator responses.
How it connects
Connects health indicators with databases, message brokers, Eureka, Config Server, and aggregate status.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Spring in Action, Sixth Edition. The section links point to the parts of the book it draws on.