Skip to content

Commit 115b369

Browse files
committed
Update documentation with new default prefix for actuators
Closes gh-6886
1 parent 9166bb5 commit 115b369

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

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

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@ includes a number of built-in endpoints and you can also add your own. For examp
5959
`health` endpoint provides basic application health information.
6060

6161
The way that endpoints are exposed will depend on the type of technology that you choose.
62-
Most applications choose HTTP monitoring, where the ID of the endpoint is mapped
63-
to a URL. For example, by default, the `health` endpoint will be mapped to `/health`.
62+
Most applications choose HTTP monitoring, where the ID of the endpoint along with a prefix of
63+
`/application` is mapped to a URL. For example, by default, the `health` endpoint will be mapped
64+
to `/application/health`.
6465

6566
The following technology agnostic endpoints are available:
6667

@@ -216,13 +217,13 @@ http://projects.spring.io/spring-hateoas[Spring HATEOAS] is on the classpath (e.
216217
through the `spring-boot-starter-hateoas` or if you are using
217218
http://projects.spring.io/spring-data-rest[Spring Data REST]) then the HTTP endpoints
218219
from the Actuator are enhanced with hypermedia links, and a "`discovery page`" is added
219-
with links to all the endpoints. The "`discovery page`" is available on `/actuator` by
220+
with links to all the endpoints. The "`discovery page`" is available on `/application` by
220221
default. It is implemented as an endpoint, allowing properties to be used to configure
221222
its path (`endpoints.actuator.path`) and whether or not it is enabled
222223
(`endpoints.actuator.enabled`).
223224

224225
When a custom management context path is configured, the "`discovery page`" will
225-
automatically move from `/actuator` to the root of the management context. For example,
226+
automatically move from `/application` to the root of the management context. For example,
226227
if the management context path is `/management` then the discovery page will be available
227228
from `/management`.
228229

@@ -537,7 +538,8 @@ additional entry:
537538
== Monitoring and management over HTTP
538539
If you are developing a Spring MVC application, Spring Boot Actuator will auto-configure
539540
all enabled endpoints to be exposed over HTTP. The default convention is to use the
540-
`id` of the endpoint as the URL path. For example, `health` is exposed as `/health`.
541+
`id` of the endpoint with a prefix of `/application` as the URL path. For example, `health`
542+
is exposed as `/application/health`.
541543

542544

543545

@@ -587,23 +589,20 @@ in your `application.properties`:
587589

588590
[[production-ready-customizing-management-server-context-path]]
589591
=== Customizing the management endpoint paths
590-
Sometimes it is useful to group all management endpoints under a single path. For example,
591-
your application might already use `/info` for another purpose. You can use the
592-
`management.context-path` property to set a prefix for your management endpoint:
592+
Sometimes it is useful to customize the prefix for the management endpoints.
593+
For example, your application might already use `/application` for another purpose.
594+
You can use the `management.context-path` property to change the prefix for your management endpoint:
593595

594596
[source,properties,indent=0]
595597
----
596598
management.context-path=/manage
597599
----
598600

599-
The `application.properties` example above will change the endpoint from `/{id}` to
601+
The `application.properties` example above will change the endpoint from `/application/{id}` to
600602
`/manage/{id}` (e.g. `/manage/info`).
601603

602-
You can also change the "`id`" of an endpoint (using `endpoints.{name}.id`) which then
603-
changes the default resource path for the MVC endpoint. Legal endpoint ids are composed
604-
only of alphanumeric characters (because they can be exposed in a number of places,
605-
including JMX object names, where special characters are forbidden). The MVC path can be
606-
changed separately by configuring `endpoints.{name}.path`, and there is no validation on
604+
You can also change the "`path`" of an endpoint (using `endpoints.{name}.path`) which then
605+
changes the default resource path for the MVC endpoint. There is no validation on
607606
those values (so you can use anything that is legal in a URL path). For example, to change
608607
the location of the `/health` endpoint to `/ping/me` you can set
609608
`endpoints.health.path=/ping/me`.

0 commit comments

Comments
 (0)