Spring Boot: Actuator
Checking the endpoint mappings, health or other info about your Spring Boot app
When building a web app it is useful to be able to:
- See a list of all the endpoints in your application, and what controller they map to (similar to a
rails routesin the Ruby on Rails framework) - Check on the health of your application
- Get other arbitrary info
You might not want to do this with a production version of the application, but during development, it is quite reasonable.
One way to accomplish this is to include the Spring Boot Actuator as one of your dependencies, by including this in your pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
You can then put this in your src/main/resources/applicaion.properties:
management.endpoint.mappings.enabled=true
management.endpoints.web.exposure.include=mappings,health,info
This allows you to visit endpoints called /mappings, /health and /info to get various kinds of information about your application.
These work best if you have loaded a JSON formatter extension to your browser such as JSONView for Chrome or JSONView for Firefox since those will allow you to see the JSON in an easily readable format.
More information
- https://www.callicoder.com/spring-boot-actuator/
- https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html#production-ready-endpoints
- Injecting git commit information: https://www.baeldung.com/spring-git-information
Related topics:
- Spring Boot: —A Java web application framework
- Spring Boot: Actuator—Checking the endpoint mappings, health or other info about your Spring Boot app
- Spring Boot: Application Properties—Defining the application.properties
- Spring Boot: ControllerAdvice—A place to factor out common ExceptionHandler, ModelAttribute and InitBinder code across multiple controllers
- Spring Boot: CSV—Downloading and Uploading CSV files with Spring Boot
- Spring Boot: Database Migrations—When you need to make a change to your database schema for an app in progress
- Spring Boot: Heroku—Tips for running with Spring Boot applications on Heroku
- Spring Boot: Logging—How to write information to the log in Spring Boot
- Spring Boot: OAuth—How to implement OAuth for authentication in Spring Boot
- Spring Boot: POST and CSRF—If you get 403 forbidden messages when using POST
- Spring Boot: Postgres—Using Spring Boot with Postgres
- Spring Boot: RestTemplate—When you need to access other APIs from the backend of your Spring Boot Application
- Spring Boot: Secrets—Ways of keepings database credentials and OAuth client secrets out of Github
- Spring Boot: Security—Authentication, Authorization and other Security issues
- Spring Boot: Sessions—How to make the stateless HTTP protocol stateful
- Spring Boot: SQL—Working with SQL and Databases in Spring Boot
- Spring Boot: VS Code—Suggested VS Code extensions for working with Spring Boot