Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Combine /links and /hal into a single /actuator endpoint

Browse Source 
This commit provides a single endpoint, /actuator, that serves HTML
(the HAL browser) or JSON depending on the request’s accept header
that enables discovery of all of the actuator’s other endpoints.

When the management context path is configured, the /actuator endpoint
moves to the configured path, e.g. if the management context path is
set to /management, the actuator endpoint will be available from
/management.

Closes gh-3696
This commit is contained in:
Andy Wilkinson
2015-08-06 15:56:06 +01:00
parent ce512a18f3
commit 58db5a3889
16 changed files with 301 additions and 508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
View File

@@ -699,6 +699,9 @@ content into your application; rather pick only the properties that you need.
endpoints.trace.enabled=true
# HYPERMEDIA ENDPOINTS
endpoints.actuator.enabled=true
endpoints.actuator.path=/actuator
endpoints.actuator.sensitive=false
endpoints.docs.curies.enabled=false
endpoints.docs.enabled=true
endpoints.docs.path=/docs
@@ -709,9 +712,6 @@ content into your application; rather pick only the properties that you need.
endpoints.hal.enabled=true
endpoints.hal.path= # Redirects root HTML traffic to the HAL browser
endpoints.hal.sensitive=false
endpoints.links.enabled=true
endpoints.links.path=/links
endpoints.links.sensitive=false
endpoints.liquibase.enabled=true
endpoints.liquibase.id=liquibase
endpoints.liquibase.sensitive=false

23
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View File

@@ -67,6 +67,10 @@ The following endpoints are available:
|===
| ID | Description | Sensitive
|`actuator`
|Provides a hypermedia-based "`discovery page`" for the other endpoints. Requires Spring
HATEOAS to be on the classpath.
|`autoconfig`
|Displays an auto-configuration report showing all auto-configuration candidates and the
reason why they '`were`' or '`were not`' applied.
@@ -169,18 +173,19 @@ If http://projects.spring.io/spring-hateoas[Spring HATEOAS] is on the classpath
through the `spring-boot-starter-hateoas` or if you are using
http://projects.spring.io/spring-data-rest[Spring Data REST]) then the HTTP endpoints
from the Actuator are enhanced with hypermedia links, and a "`discovery page`" is added
with links to all the endpoints. The "`discovery page`" is actually an endpoint itself,
so it can be disabled along with the rest of the hypermedia by setting
`endpoints.links.enabled=false`. If it is not explicitly disabled the links
endpoint renders a JSON object with a link for each other endpoint on `/links`. If Spring
Data REST is used, the root endpoint is enhanced with an extra `actuator` links that
points to the "`discovery page`".
with links to all the endpoints. The "`discovery page`" is available on `/actuator` by
default. It is implemented as an endpoint, allowing properties to be used to configure
its path (`endpoints.actuator.path`) and whether or not it is enabled
(`endpoints.actuator.enabled`).
When a custom management context path is configured, the "`discovery page`" will
automatically move from `/actuator` to the root of the management context. For example,
if the management context path is `/management` then the discovery page will be available
from `/management`.
If the https://github.com/mikekelly/hal-browser[HAL Browser] is on the classpath
via its webjar (`org.webjars:hal-browser`), or via the `spring-data-rest-hal-browser` then
the default home page for HTML clients will be the HAL Browser. This is also exposed via
an endpoint ("`hal`") so it can be disabled and have its path explicitly configured like
the other endpoints.
an HTML "`discovery page`", in the form of the HAL Browser, is also provided.