Update actuator doc and user guide (flowable#3077)

* flowable#3066 update ch05a-Spring-Boot.md * flowable#3066 update ch05a-Spring-Boot.adoc * flowable#3066 improve the rigor * flowable#3066 fix adoc zh_CN link * flowable#3066 add the determiner "the" before the word "web" * flowable#3066 change "eg" to "e.g."
5721617zzw · Nov 2, 2021 · 3b8e2f5 · 3b8e2f5
1 parent 2dee131
commit 3b8e2f5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/docusaurus/docs/bpmn/ch05a-Spring-Boot.md b/docs/docusaurus/docs/bpmn/ch05a-Spring-Boot.md
@@ -526,8 +526,8 @@ And the task list is now fetched using the person ID:
 ## Flowable Actuator Endpoints
 
 Flowable provides a Spring Boot Actuator Endpoint that exposes information for the Processes that are running.
-By default the `flowable` endpoint is mapped to `/actuator/flowable`.
-Spring Boot by default only exposes the `info` and `health` endpoints. In order to enable the `flowable` endpoint you need to add `management.endpoint.flowable.enabled=true` to your `application.properties`.
+By default, the `flowable` endpoint is mapped to `/actuator/flowable`.
+Spring Boot by default only exposes a few endpoints to the web (e.g.: In `spring-boot-starter-actuator:2.5.4` , Spring Boot by default only exposes the `health` endpoint to the web. For more information about the endpoints exposed to the web by default, see [https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.exposing](https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.exposing) ). In order to use the `flowable` endpoint through the web, you need to add `management.endpoints.web.exposure.include=flowable` to your `application.properties` (Note: The `org.flowable.spring.boot.EndpointAutoConfiguration` class does not use the `@ConditionalOnAvailableEndpoint` annotation to check whether the `flowable` endpoint is both enabled and exposed like the `HealthEndpointAutoConfiguration` class. So the only thing you need to do to use the `flowable` endpoint through the web is to add `management.endpoints.web.exposure.include=flowable` or `management.endpoints.web.exposure.include=*` to your configuration file.).
 
 In order to make enable Actuator endpoints you need to add a dependency on Actuator, e.g. by using {sc-flowable-starter}/flowable-spring-boot-starter-actuator/pom.xml\[flowable-spring-boot-starter-actuator\].
 

diff --git a/docs/userguide/src/en/bpmn/ch05a-Spring-Boot.adoc b/docs/userguide/src/en/bpmn/ch05a-Spring-Boot.adoc
@@ -583,8 +583,8 @@ curl http://localhost:8080/tasks?assignee=1
 ==== Flowable Actuator Endpoints
 
 Flowable provides a Spring Boot Actuator Endpoint that exposes information for the Processes that are running.
-By default the `flowable` endpoint is mapped to `/actuator/flowable`.
-Spring Boot by default only exposes the `info` and `health` endpoints. In order to enable the `flowable` endpoint you need to add `management.endpoint.flowable.enabled=true` to your `application.properties`.
+By default, the `flowable` endpoint is mapped to `/actuator/flowable`.
+Spring Boot by default only exposes a few endpoints to the web (e.g.: In `spring-boot-starter-actuator:2.5.4` , Spring Boot by default only exposes the `health` endpoint to the web. For more information about the endpoints exposed to the web by default, see link:$$https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.exposing$$[https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.exposing]). In order to use the `flowable` endpoint through the web, you need to add `management.endpoints.web.exposure.include=flowable` to your `application.properties` (Note: The `org.flowable.spring.boot.EndpointAutoConfiguration` class does not use the `@ConditionalOnAvailableEndpoint` annotation to check whether the `flowable` endpoint is both enabled and exposed like the `HealthEndpointAutoConfiguration` class. So the only thing you need to do to use the `flowable` endpoint through the web is to add `management.endpoints.web.exposure.include=flowable` or `management.endpoints.web.exposure.include=*` to your configuration file. ).
 
 In order to make enable Actuator endpoints you need to add a dependency on Actuator, e.g. by using {sc-flowable-starter}/flowable-spring-boot-starter-actuator/pom.xml[flowable-spring-boot-starter-actuator].
 

diff --git a/docs/userguide/src/zh_CN/bpmn/ch05a-Spring-Boot.adoc b/docs/userguide/src/zh_CN/bpmn/ch05a-Spring-Boot.adoc
@@ -584,7 +584,7 @@ curl http://localhost:8080/tasks?assignee=1
 
 Flowable提供了Spring Boot Actuator Endpoint，以提供正在运行的流程的信息。
 默认情况下 `flowable` 端点映射至 `/actuator/flowable` 。
-Spring Boot默认只提供 `info` 与 `health` 端点。要启用 `flowable` 端点，需要在 `application.properties` 中添加 `management.endpoint.flowable.enabled=true` 。
+Spring Boot默认只通过web暴露少许端点（例如：在 `spring-boot-starter-actuator:2.5.4` 中， Spring Boot 默认只通过web暴露了 `health` 端点。更多有关于 Spring Boot 默认暴露的端点的信息，请参考 link:$$https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.exposing$$[https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints.exposing] ）。要通过web使用 `flowable` 端点，需要在 `application.properties` 中添加 `management.endpoints.web.exposure.include=flowable` （注意： `org.flowable.spring.boot.EndpointAutoConfiguration` 类没有使用 `@ConditionalOnAvailableEndpoint` 注解检查 `flowable` 的端点是否同时被启用和被暴露。所以为了通过web使用 `flowable` 端点，你只需要在配置文件中添加 `management.endpoints.web.exposure.include=flowable` 或 `management.endpoints.web.exposure.include=*` 即可）。
 
 `curl http://localhost:8080/actuator/flowable`