CODEWITHSUNDEEP
javaspring-bootspring-boot-actuator
Abhijit
Abhijit

Reputation: 175

SpringBoot 2 health end point JSON format has changed

We have recently upgraded out Spring-Boot version to 2.1.2 in one of our applications. I noticed a change in JSON format when I hit this URL: http://localhost:xxxx/health.

The changed structure is: { Health: { status: "UP" } }

Earlier it was: { status: "UP" }

My question is; 1. Why has it been modified? 2. Is there any config to keep the structure as it was before?

Upvotes: 1

Views: 1599

Answers (1)

Ryuzaki L
Ryuzaki L

Reputation: 40078

With the release of Spring Boot 2, Actuator has been redesigned, and new exciting endpoints were added.

The /actuator/health endpoint is used to check the health or state of the running application. It’s usually exercised by monitoring software to alert us if the running instance goes down or gets unhealthy for other reasons. E.g. Connectivity issues with our DB, lack of disk space…

http://localhost:8080/actuator/health

{
status: "UP"
}

Monitoring and Management over HTTP

If you are developing a web application, Spring Boot Actuator auto-configures all enabled endpoints to be exposed over HTTP. The default convention is to use the id of the endpoint with a prefix of /actuator as the URL path. For example, health is exposed as /actuator/health. TIP: Actuator is supported natively with Spring MVC, Spring WebFlux, and Jersey.

Actuator Security

For security purposes, all actuators other than /health and /info are disabled by default. The management.endpoints.web.exposure.include property can be used to enable the actuators.

If Spring Security is on the classpath and no other WebSecurityConfigurerAdapter is present, all actuators other than /health and /info are secured by Spring Boot auto-configuration. If you define a custom WebSecurityConfigurerAdapter, Spring Boot auto-configuration will back off and you will be in full control of actuator access rules.

Endpoints

Actuator endpoints let you monitor and interact with your application. Spring Boot includes a number of built-in endpoints and lets you add your own. For example, the health endpoint provides basic application health information.

Each individual endpoint can be enabled or disabled. This controls whether or not the endpoint is created and its bean exists in the application context. To be remotely accessible an endpoint also has to be exposed via JMX or HTTP. Most applications choose HTTP, where the ID of the endpoint along with a prefix of /actuator is mapped to a URL. For example, by default, the health endpoint is mapped to /actuator/health.

Actuator JSON

The JSON payloads returned from many endpoints have been improved with Spring Boot 2.0.

Many endpoints now have JSON that more accurately reflects the underlying data. For example, the /actuator/conditions endpoint (/autoconfig in Spring Boot 1.5) now has a top level contexts key to group results by ApplicationContext.

8. Health (health)

To retrieve the health of the application, make a GET request to /actuator/health, as shown in the following curl-based example:

$ curl 'http://localhost:8080/actuator/health' -i -X GET

Useful Information : Baeldung

Upvotes: 6

Related Questions