Operations Basics / Version 2207
Table Of ContentsThe health endpoint can be enriched with custom health checks by adding classes extending the org.springframework.boot.actuate.health.HealthIndicator
class of the Spring Boot framework. Each health indicator is a bean with a name suffix healthIndicator
. In the example
below we will describe the usage on a health indicator with the name uapiConnection
.
By default the health indicator can be enabled or disbled by configuring the following property:
Endpoint properties.
management.health.uapiConnection.enabled=true
When activated, the health indicator will extend the default health endpoint with its name as its subpath.
Endpoint details activated.
management.endpoint.health.show-details=always
Endpoint URL.
http://localhost:8081/actuator/health/uapiConnection
When requested using a GET HTTP request, the endpoint will response with a HTTP return code, matching the state of the check.
Response.
{ "status": "UP","uapiConnection": { "status": "UP",
"details": { "content repository": "OK"
} } }