46. Endpoints
Actuator endpoints allow you to monitor and interact with your application. Spring Boot includes a number of built-in endpoints and you can also add your own. For example the health
endpoint provides basic application health information.
The way that endpoints are exposed will depend on the type of technology that you choose. Most applications choose HTTP monitoring, where the ID of the endpoint is mapped to a URL. For example, by default, the health
endpoint will be mapped to /health
.
The following technology agnostic endpoints are available:
ID | Description | Sensitive Default |
---|---|---|
actuator |
Provides a hypermedia-based “discovery page” for the other endpoints. Requires Spring HATEOAS to be on the classpath. | true |
autoconfig |
Displays an auto-configuration report showing all auto-configuration candidates and the reason why they ‘were’ or ‘were not’ applied. | true |
beans |
Displays a complete list of all the Spring beans in your application. | true |
configprops |
Displays a collated list of all @ConfigurationProperties . |
true |
dump |
Performs a thread dump. | true |
env |
Exposes properties from Spring’s ConfigurableEnvironment . |
true |
flyway |
Shows any Flyway database migrations that have been applied. | true |
health |
Shows application health information (when the application is secure, a simple ‘status’ when accessed over an unauthenticated connection or full message details when authenticated). | false |
info |
Displays arbitrary application info. | false |
liquibase |
Shows any Liquibase database migrations that have been applied. | true |
metrics |
Shows ‘metrics’ information for the current application. | true |
mappings |
Displays a collated list of all @RequestMapping paths. |
true |
shutdown |
Allows the application to be gracefully shutdown (not enabled by default). | true |
trace |
Displays trace information (by default the last 100 HTTP requests). | true |
If you are using Spring MVC, the following additional endpoints can also be used:
ID | Description | Sensitive Default |
---|---|---|
docs |
Displays documentation, including example requests and responses, for the Actuator’s endpoints. Requires spring-boot-actuator-docs to be on the classpath. |
false |
heapdump |
Returns a GZip compressed hprof heap dump file. |
true |
jolokia |
Exposes JMX beans over HTTP (when Jolokia is on the classpath). | true |
logfile |
Returns the contents of the logfile (if logging.file or logging.path properties have been set). Supports the use of the HTTP Range header to retrieve part of the log file’s content. |
true |
Note | |
---|---|
Depending on how an endpoint is exposed, the sensitive property may be used as a security hint. For example, sensitive endpoints will require a username/password when they are accessed over HTTP (or simply disabled if web security is not enabled). |