Skip to content

Commit 3884ec3

Browse files
committed
Merge pull request #27759 from Buzzardo
* pr/27759: Make editorial changes to actuator documentation Update actuator docs to prefer "You can..." Improve actuator example lead-in text Polish actuator docs markup and formatting Closes gh-27759
2 parents 393081f + f7f5f9f commit 3884ec3

File tree

11 files changed

+361
-346
lines changed

11 files changed

+361
-346
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/auditing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Once Spring Security is in play, Spring Boot Actuator has a flexible audit framework that publishes events (by default, "`authentication success`", "`failure`" and "`access denied`" exceptions).
44
This feature can be very useful for reporting and for implementing a lock-out policy based on authentication failures.
55

6-
Auditing can be enabled by providing a bean of type `AuditEventRepository` in your application's configuration.
6+
You can enable auditing by providing a bean of type `AuditEventRepository` in your application's configuration.
77
For convenience, Spring Boot offers an `InMemoryAuditEventRepository`.
8-
`InMemoryAuditEventRepository` has limited capabilities and we recommend using it only for development environments.
8+
`InMemoryAuditEventRepository` has limited capabilities, and we recommend using it only for development environments.
99
For production environments, consider creating your own alternative `AuditEventRepository` implementation.
1010

1111

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/cloud-foundry.adoc

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ Spring Boot's actuator module includes additional support that is activated when
44
The `/cloudfoundryapplication` path provides an alternative secured route to all `@Endpoint` beans.
55

66
The extended support lets Cloud Foundry management UIs (such as the web application that you can use to view deployed applications) be augmented with Spring Boot actuator information.
7-
For example, an application status page may include full health information instead of the typical "`running`" or "`stopped`" status.
7+
For example, an application status page can include full health information instead of the typical "`running`" or "`stopped`" status.
88

99
NOTE: The `/cloudfoundryapplication` path is not directly accessible to regular users.
10-
In order to use the endpoint, a valid UAA token must be passed with the request.
10+
To use the endpoint, you must pass a valid UAA token with the request.
1111

1212

1313

1414
[[actuator.cloud-foundry.disable]]
1515
=== Disabling Extended Cloud Foundry Actuator Support
1616
If you want to fully disable the `/cloudfoundryapplication` endpoints, you can add the following setting to your `application.properties` file:
1717

18-
1918
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
2019
----
2120
management:
@@ -41,12 +40,12 @@ If your Cloud Foundry UAA or Cloud Controller services use self-signed certifica
4140

4241
[[actuator.cloud-foundry.custom-context-path]]
4342
=== Custom Context Path
44-
If the server's context-path has been configured to anything other than `/`, the Cloud Foundry endpoints will not be available at the root of the application.
45-
For example, if `server.servlet.context-path=/app`, Cloud Foundry endpoints will be available at `/app/cloudfoundryapplication/*`.
43+
If the server's context-path has been configured to anything other than `/`, the Cloud Foundry endpoints are not available at the root of the application.
44+
For example, if `server.servlet.context-path=/app`, Cloud Foundry endpoints are available at `/app/cloudfoundryapplication/*`.
4645

47-
If you expect the Cloud Foundry endpoints to always be available at `/cloudfoundryapplication/*`, regardless of the server's context-path, you will need to explicitly configure that in your application.
48-
The configuration will differ depending on the web server in use.
49-
For Tomcat, the following configuration can be added:
46+
If you expect the Cloud Foundry endpoints to always be available at `/cloudfoundryapplication/*`, regardless of the server's context-path, you need to explicitly configure that in your application.
47+
The configuration differs, depending on the web server in use.
48+
For Tomcat, you can add the following configuration:
5049

5150
[source,java,indent=0,subs="verbatim"]
5251
----

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/enabling.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
[[actuator.enabling]]
22
== Enabling Production-ready Features
33
The {spring-boot-code}/spring-boot-project/spring-boot-actuator[`spring-boot-actuator`] module provides all of Spring Boot's production-ready features.
4-
The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` '`Starter`'.
4+
The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` "`Starter`".
55

66
.Definition of Actuator
77
****
88
An actuator is a manufacturing term that refers to a mechanical device for moving or controlling something.
99
Actuators can generate a large amount of motion from a small change.
1010
****
1111

12-
To add the actuator to a Maven based project, add the following '`Starter`' dependency:
12+
To add the actuator to a Maven-based project, add the following '`Starter`' dependency:
1313

1414
[source,xml,indent=0,subs="verbatim"]
1515
----

0 commit comments

Comments
 (0)