Spring Boot includes the Spring Boot Actuator. This section answers questions that often arise from its use.
In a standalone application, the Actuator HTTP port defaults to the same as the main HTTP port.
To make the application listen on a different port, set the external property: configprop:management.server.port.
To listen on a completely different network address (such as when you have an internal network for management and an external one for user applications), you can also set
management.server.address to a valid IP address to which the server is able to bind.
For more detail, see the
ManagementServerProperties source code and “production-ready-customizing-management-server-port” in the “Production-ready features” section.
Spring Boot installs a ‘whitelabel’ error page that you see in a browser client if you encounter a server error (machine clients consuming JSON and other media types should see a sensible response with the right error code).
Overriding the error page with your own depends on the templating technology that you use.
For example, if you use Thymeleaf, you can add an
If you use FreeMarker, you can add an
In general, you need a
View that resolves with a name of
error or a
@Controller that handles the
Unless you replaced some of the default configuration, you should find a
BeanNameViewResolver in your
ApplicationContext, so a
error would be a simple way of doing that.
ErrorMvcAutoConfiguration for more options.
See also the section on “ Error Handling” for details of how to register handlers in the servlet container.
Information returned by the
configprops endpoints can be somewhat sensitive so keys matching a certain pattern are sanitized by default (i.e. their values are replaced by
Spring Boot uses sensible defaults for such keys: for instance, any key ending with the word "password", "secret", "key" or "token" is sanitized.
It is also possible to use a regular expression instead, such as
*credentials.* to sanitize any key that holds the word
credentials as part of the key.
The patterns to use can be customized using the