From abf5e63b5410a570265ed16d2f5c5db171559915 Mon Sep 17 00:00:00 2001 From: kuldeepsidhu88 Date: Sun, 26 Aug 2018 23:31:06 +0530 Subject: [PATCH 1/2] Remove redundancy from actuator documentation See gh-14206 --- .../asciidoc/production-ready-features.adoc | 63 ++++++++++--------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index 28a7816426..084e4c5ac9 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -461,25 +461,6 @@ disabled to prevent the possibility of a clash with other mappings. -[[production-ready-endpoints-custom-mapping]] -=== Actuator Web Endpoint Paths -By default, endpoints are exposed over HTTP under the `/actuator` path by using the ID of -the endpoint. For example, the `beans` endpoint is exposed under `/actuator/beans`. If you -want to map endpoints to a different path, you can use the -`management.endpoints.web.path-mapping` property. Also, if you want change the base path, -you can use `management.endpoints.web.base-path`. - -The following example remaps `/actuator/health` to `/healthcheck`: - -.application.properties -[source,properties,indent=0] ----- - management.endpoints.web.base-path=/ - management.endpoints.web.path-mapping.health=healthcheck ----- - - - [[production-ready-endpoints-cors]] === CORS Support https://en.wikipedia.org/wiki/Cross-origin_resource_sharing[Cross-origin resource sharing] @@ -1059,20 +1040,11 @@ additional entry: -[[production-ready-monitoring]] -== Monitoring and Management over HTTP -If you are developing a web application, Spring Boot Actuator auto-configures all -enabled endpoints to be exposed over HTTP. The default convention is to use the `id` of -the endpoint with a prefix of `/actuator` as the URL path. For example, `health` is -exposed as `/actuator/health`. - -TIP: Actuator is supported natively with Spring MVC, Spring WebFlux, and Jersey. - - - [[production-ready-customizing-management-server-context-path]] === Customizing the Management Endpoint Paths -Sometimes, it is useful to customize the prefix for the management endpoints. For +Sometimes, it is useful to customize the prefix for the management endpoints. By default, +endpoints are exposed over HTTP under the `/actuator` path by using the ID of +the endpoint. For example, your application might already use `/actuator` for another purpose. You can use the `management.endpoints.web.base-path` property to change the prefix for your management endpoint, as shown in the following example: @@ -1092,7 +1064,17 @@ different HTTP port>>, `management.endpoints.web.base-path` is relative to `management.endpoints.web.base-path` is relative to `management.server.servlet.context-path`. +If you want to map endpoints to a different path, you can use the +`management.endpoints.web.path-mapping` property. +The following example remaps `/actuator/health` to `/healthcheck`: + +.application.properties +[source,properties,indent=0] +---- + management.endpoints.web.base-path=/ + management.endpoints.web.path-mapping.health=healthcheck +---- [[production-ready-customizing-management-server-port]] === Customizing the Management Server Port @@ -1175,7 +1157,26 @@ If you do not want to expose endpoints over HTTP, you can set the management por management.server.port=-1 ---- +Above can be achieved using the property `management.endpoints.web.exposure.exclude` as well, as shown in +following example: +[source,properties,indent=0] +---- + management.endpoints.web.exposure.exclude=* +---- + +`*` can be used to select all endpoints. + +If you want to disable HTTP endpoints selectively, configure the list of endpoints IDs to be disabled in +`management.endpoints.web.exposure.exclude` property +as shown in following example: + +[source,properties,indent=0] +---- + management.endpoints.web.exposure.exclude=env,beans +---- + +`env` and `beans` endpoints will not be exposed over HTTP. [[production-ready-jmx]] == Monitoring and Management over JMX From ccdbc0aa068e3d79321b6ecec7601b86548b9e86 Mon Sep 17 00:00:00 2001 From: Madhura Bhave Date: Thu, 6 Sep 2018 15:40:13 -0700 Subject: [PATCH 2/2] Polish "Remove redundancy from actuator documentation" Closes gh-14206 --- .../asciidoc/production-ready-features.adoc | 28 +++++++++---------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index 084e4c5ac9..bbfede2651 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -1039,12 +1039,19 @@ additional entry: ---- +[[production-ready-monitoring]] +== Monitoring and Management over HTTP +If you are developing a web application, Spring Boot Actuator auto-configures all +enabled endpoints to be exposed over HTTP. The default convention is to use the `id` of +the endpoint with a prefix of `/actuator` as the URL path. For example, `health` is +exposed as `/actuator/health`. +TIP: Actuator is supported natively with Spring MVC, Spring WebFlux, and Jersey. + + [[production-ready-customizing-management-server-context-path]] === Customizing the Management Endpoint Paths -Sometimes, it is useful to customize the prefix for the management endpoints. By default, -endpoints are exposed over HTTP under the `/actuator` path by using the ID of -the endpoint. For +Sometimes, it is useful to customize the prefix for the management endpoints. For example, your application might already use `/actuator` for another purpose. You can use the `management.endpoints.web.base-path` property to change the prefix for your management endpoint, as shown in the following example: @@ -1076,6 +1083,8 @@ The following example remaps `/actuator/health` to `/healthcheck`: management.endpoints.web.path-mapping.health=healthcheck ---- + + [[production-ready-customizing-management-server-port]] === Customizing the Management Server Port Exposing management endpoints by using the default HTTP port is a sensible choice for @@ -1157,7 +1166,7 @@ If you do not want to expose endpoints over HTTP, you can set the management por management.server.port=-1 ---- -Above can be achieved using the property `management.endpoints.web.exposure.exclude` as well, as shown in +This can be achieved using the `management.endpoints.web.exposure.exclude` property as well, as shown in following example: [source,properties,indent=0] @@ -1165,18 +1174,7 @@ following example: management.endpoints.web.exposure.exclude=* ---- -`*` can be used to select all endpoints. -If you want to disable HTTP endpoints selectively, configure the list of endpoints IDs to be disabled in -`management.endpoints.web.exposure.exclude` property -as shown in following example: - -[source,properties,indent=0] ----- - management.endpoints.web.exposure.exclude=env,beans ----- - -`env` and `beans` endpoints will not be exposed over HTTP. [[production-ready-jmx]] == Monitoring and Management over JMX