Skip to content

Commit 4675eee

Browse files
author
Jay Bryant
committed
Editing pass for the Actuator section
1 parent 8966b13 commit 4675eee

File tree

12 files changed

+550
-357
lines changed

12 files changed

+550
-357
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,9 @@
22
= Production-ready Features
33
include::attributes.adoc[]
44

5-
6-
75
Spring Boot includes a number of additional features to help you monitor and manage your application when you push it to production.
86
You can choose to manage and monitor your application by using HTTP endpoints or with JMX.
9-
Auditing, health, and metrics gathering can also be automatically applied to your application.
10-
11-
7+
You can also automatically apply auditing, health, and metrics gathering to your application.
128

139
include::actuator/enabling.adoc[]
1410

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: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,25 @@ 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-
18+
====
1919
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
2020
----
2121
management:
2222
cloudfoundry:
2323
enabled: false
2424
----
25+
====
2526

2627

2728

@@ -30,25 +31,29 @@ If you want to fully disable the `/cloudfoundryapplication` endpoints, you can a
3031
By default, the security verification for `/cloudfoundryapplication` endpoints makes SSL calls to various Cloud Foundry services.
3132
If your Cloud Foundry UAA or Cloud Controller services use self-signed certificates, you need to set the following property:
3233

34+
====
3335
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
3436
----
3537
management:
3638
cloudfoundry:
3739
skip-ssl-validation: true
3840
----
41+
====
3942

4043

4144

4245
[[actuator.cloud-foundry.custom-context-path]]
4346
=== 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/*`.
47+
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.
48+
For example, if `server.servlet.context-path=/app`, Cloud Foundry endpoints are available at `/app/cloudfoundryapplication/*`.
4649

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:
50+
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.
51+
The configuration differs, depending on the web server in use.
52+
For Tomcat, you can add the following configuration:
5053

54+
====
5155
[source,java,indent=0,subs="verbatim"]
5256
----
5357
include::{docs-java}/actuator/cloudfoundry/customcontextpath/MyCloudFoundryConfiguration.java[]
5458
----
59+
====
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
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

14+
====
1415
[source,xml,indent=0,subs="verbatim"]
1516
----
1617
<dependencies>
@@ -20,12 +21,15 @@ To add the actuator to a Maven based project, add the following '`Starter`' depe
2021
</dependency>
2122
</dependencies>
2223
----
24+
====
2325

2426
For Gradle, use the following declaration:
2527

28+
====
2629
[source,gradle,indent=0,subs="verbatim"]
2730
----
2831
dependencies {
2932
implementation 'org.springframework.boot:spring-boot-starter-actuator'
3033
}
3134
----
35+
====

0 commit comments

Comments
 (0)