You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Closesgh-27759
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/auditing.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@
3
3
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).
4
4
This feature can be very useful for reporting and for implementing a lock-out policy based on authentication failures.
5
5
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.
7
7
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.
9
9
For production environments, consider creating your own alternative `AuditEventRepository` implementation.
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/cloud-foundry.adoc
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,17 @@ Spring Boot's actuator module includes additional support that is activated when
4
4
The `/cloudfoundryapplication` path provides an alternative secured route to all `@Endpoint` beans.
5
5
6
6
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.
8
8
9
9
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.
11
11
12
12
13
13
14
14
[[actuator.cloud-foundry.disable]]
15
15
=== Disabling Extended Cloud Foundry Actuator Support
16
16
If you want to fully disable the `/cloudfoundryapplication` endpoints, you can add the following setting to your `application.properties` file:
@@ -41,12 +40,12 @@ If your Cloud Foundry UAA or Cloud Controller services use self-signed certifica
41
40
42
41
[[actuator.cloud-foundry.custom-context-path]]
43
42
=== 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/*`.
46
45
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:
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/enabling.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
[[actuator.enabling]]
2
2
== Enabling Production-ready Features
3
3
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`".
5
5
6
6
.Definition of Actuator
7
7
****
8
8
An actuator is a manufacturing term that refers to a mechanical device for moving or controlling something.
9
9
Actuators can generate a large amount of motion from a small change.
10
10
****
11
11
12
-
To add the actuator to a Mavenbased project, add the following '`Starter`' dependency:
12
+
To add the actuator to a Maven-based project, add the following '`Starter`' dependency:
0 commit comments