Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
115b3696
Commit
115b3696
authored
Apr 19, 2017
by
Madhura Bhave
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation with new default prefix for actuators
Closes gh-6886
parent
9166bb5f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
14 deletions
+13
-14
production-ready-features.adoc
...oot-docs/src/main/asciidoc/production-ready-features.adoc
+13
-14
No files found.
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file @
115b3696
...
@@ -59,8 +59,9 @@ includes a number of built-in endpoints and you can also add your own. For examp
...
@@ -59,8 +59,9 @@ includes a number of built-in endpoints and you can also add your own. For examp
`health` endpoint provides basic application health information.
`health` endpoint provides basic application health information.
The way that endpoints are exposed will depend on the type of technology that you choose.
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
Most applications choose HTTP monitoring, where the ID of the endpoint along with a prefix of
to a URL. For example, by default, the `health` endpoint will be mapped to `/health`.
`/application` is mapped to a URL. For example, by default, the `health` endpoint will be mapped
to `/application/health`.
The following technology agnostic endpoints are available:
The following technology agnostic endpoints are available:
...
@@ -216,13 +217,13 @@ http://projects.spring.io/spring-hateoas[Spring HATEOAS] is on the classpath (e.
...
@@ -216,13 +217,13 @@ http://projects.spring.io/spring-hateoas[Spring HATEOAS] is on the classpath (e.
through the `spring-boot-starter-hateoas` or if you are using
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
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
from the Actuator are enhanced with hypermedia links, and a "`discovery page`" is added
with links to all the endpoints. The "`discovery page`" is available on `/a
ctuator
` by
with links to all the endpoints. The "`discovery page`" is available on `/a
pplication
` by
default. It is implemented as an endpoint, allowing properties to be used to configure
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
its path (`endpoints.actuator.path`) and whether or not it is enabled
(`endpoints.actuator.enabled`).
(`endpoints.actuator.enabled`).
When a custom management context path is configured, the "`discovery page`" will
When a custom management context path is configured, the "`discovery page`" will
automatically move from `/a
ctuator
` to the root of the management context. For example,
automatically move from `/a
pplication
` to the root of the management context. For example,
if the management context path is `/management` then the discovery page will be available
if the management context path is `/management` then the discovery page will be available
from `/management`.
from `/management`.
...
@@ -537,7 +538,8 @@ additional entry:
...
@@ -537,7 +538,8 @@ additional entry:
== Monitoring and management over HTTP
== Monitoring and management over HTTP
If you are developing a Spring MVC application, Spring Boot Actuator will auto-configure
If you are developing a Spring MVC application, Spring Boot Actuator will auto-configure
all enabled endpoints to be exposed over HTTP. The default convention is to use the
all enabled endpoints to be exposed over HTTP. The default convention is to use the
`id` of the endpoint as the URL path. For example, `health` is exposed as `/health`.
`id` of the endpoint with a prefix of `/application` as the URL path. For example, `health`
is exposed as `/application/health`.
...
@@ -587,23 +589,20 @@ in your `application.properties`:
...
@@ -587,23 +589,20 @@ in your `application.properties`:
[[production-ready-customizing-management-server-context-path]]
[[production-ready-customizing-management-server-context-path]]
=== Customizing the management endpoint paths
=== Customizing the management endpoint paths
Sometimes it is useful to
group all management endpoints under a single path. For example,
Sometimes it is useful to
customize the prefix for the management endpoints.
your application might already use `/info` for another purpose. You can use the
For example, your application might already use `/application` for another purpose.
`management.context-path` property to set a
prefix for your management endpoint:
You can use the `management.context-path` property to change the
prefix for your management endpoint:
[source,properties,indent=0]
[source,properties,indent=0]
----
----
management.context-path=/manage
management.context-path=/manage
----
----
The `application.properties` example above will change the endpoint from `/{id}` to
The `application.properties` example above will change the endpoint from `/
application/
{id}` to
`/manage/{id}` (e.g. `/manage/info`).
`/manage/{id}` (e.g. `/manage/info`).
You can also change the "`id`" of an endpoint (using `endpoints.{name}.id`) which then
You can also change the "`path`" of an endpoint (using `endpoints.{name}.path`) which then
changes the default resource path for the MVC endpoint. Legal endpoint ids are composed
changes the default resource path for the MVC endpoint. There is no validation on
only of alphanumeric characters (because they can be exposed in a number of places,
including JMX object names, where special characters are forbidden). The MVC path can be
changed separately by configuring `endpoints.{name}.path`, and there is no validation on
those values (so you can use anything that is legal in a URL path). For example, to change
those values (so you can use anything that is legal in a URL path). For example, to change
the location of the `/health` endpoint to `/ping/me` you can set
the location of the `/health` endpoint to `/ping/me` you can set
`endpoints.health.path=/ping/me`.
`endpoints.health.path=/ping/me`.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment