Health endpoint customization in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of customizing the health endpoint in Spring Boot?

Customizing the health endpoint allows you to control what health information is exposed, add custom health checks, and tailor the response to fit your application's monitoring needs.

intermediate

How do you add a custom health indicator in Spring Boot?

Create a class that implements the HealthIndicator interface and override the health() method to return Health.up() or Health.down() with details. Then register it as a Spring bean.

beginner

Which property controls the exposure of health details in Spring Boot's actuator?

The property 'management.endpoint.health.show-details' controls whether health details are shown. It can be set to 'never', 'when-authorized', or 'always'.

beginner

What is the default URL path for the health endpoint in Spring Boot Actuator?

The default URL path is '/actuator/health'.

intermediate

How can you restrict health endpoint access to authorized users only?

Use Spring Security to secure the '/actuator/health' endpoint and configure roles or authorities to allow access only to authorized users.

What interface should you implement to create a custom health check in Spring Boot?

A HealthProvider

B HealthCheck

C HealthService

D HealthIndicator

The HealthIndicator interface is used to create custom health checks by implementing its health() method.

Which property controls the visibility of detailed health information?

A management.endpoint.health.show-details

B management.health.details.visible

C spring.health.details.show

D management.health.show

The property 'management.endpoint.health.show-details' controls if detailed health info is shown.

What is the default path to access the health endpoint in Spring Boot Actuator?

A /health

B /actuator/health

C /status/health

D /monitor/health

By default, Spring Boot Actuator exposes the health endpoint at '/actuator/health'.

How can you add custom details to the health response?

A By adding key-value pairs in the health() method of a HealthIndicator

B By modifying application.properties

C By creating a new controller

D By changing the actuator base path

Custom details are added by returning Health.up().withDetail("key", value) in the health() method.

To secure the health endpoint, you should:

A Change the endpoint URL

B Disable the health endpoint

C Use Spring Security to restrict access

D Use a firewall rule

Spring Security is the recommended way to restrict access to actuator endpoints including health.

Explain how to create and register a custom health indicator in Spring Boot.

Think about the interface and method you need to override.

Describe how to control the visibility of health endpoint details and secure access to it.

Consider both configuration properties and security setup.