Skip to content

Commit f7f5f9f

Browse files
Jay Bryantphilwebb
authored andcommitted
Make editorial changes to actuator documentation
See gh-27759
1 parent 2691828 commit f7f5f9f

File tree

7 files changed

+275
-271
lines changed

7 files changed

+275
-271
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ If your Cloud Foundry UAA or Cloud Controller services use self-signed certifica
4040

4141
[[actuator.cloud-foundry.custom-context-path]]
4242
=== Custom Context Path
43-
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.
44-
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/*`.
4545

46-
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.
47-
The configuration will differ depending on the web server in use.
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.
4848
For Tomcat, you can add the following configuration:
4949

5050
[source,java,indent=0,subs="verbatim"]

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

Lines changed: 102 additions & 97 deletions
Large diffs are not rendered by default.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ You can turn it on by setting the configprop:spring.jmx.enabled[] configuration
66
Spring Boot exposes the most suitable `MBeanServer` as a bean with an ID of `mbeanServer`.
77
Any of your beans that are annotated with Spring JMX annotations (`@ManagedResource`, `@ManagedAttribute`, or `@ManagedOperation`) are exposed to it.
88

9-
If your platform provides a standard `MBeanServer`, Spring Boot will use that and default to the VM `MBeanServer` if necessary.
10-
If all that fails, a new `MBeanServer` will be created.
9+
If your platform provides a standard `MBeanServer`, Spring Boot uses that and defaults to the VM `MBeanServer`, if necessary.
10+
If all that fails, a new `MBeanServer` is created.
1111

1212
See the {spring-boot-autoconfigure-module-code}/jmx/JmxAutoConfiguration.java[`JmxAutoConfiguration`] class for more details.
1313

14-
Spring Boot also exposes management endpoints as JMX MBeans under the `org.springframework.boot` domain by default.
15-
To Take full control over endpoints registration in the JMX domain, consider registering your own `EndpointObjectNameFactory` implementation.
14+
By default, Spring Boot also exposes management endpoints as JMX MBeans under the `org.springframework.boot` domain.
15+
To take full control over endpoint registration in the JMX domain, consider registering your own `EndpointObjectNameFactory` implementation.
1616

1717

1818

@@ -73,8 +73,8 @@ You can then expose the Jolokia endpoint by adding `jolokia` or `*` to the confi
7373
You can then access it by using `/actuator/jolokia` on your management HTTP server.
7474

7575
NOTE: The Jolokia endpoint exposes Jolokia's servlet as an actuator endpoint.
76-
As a result, it is specific to servlet environments such as Spring MVC and Jersey.
77-
The endpoint will not be available in a WebFlux application.
76+
As a result, it is specific to servlet environments, such as Spring MVC and Jersey.
77+
The endpoint is not available in a WebFlux application.
7878

7979

8080

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

Lines changed: 147 additions & 148 deletions
Large diffs are not rendered by default.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The default convention is to use the `id` of the endpoint with a prefix of `/act
55
For example, `health` is exposed as `/actuator/health`.
66

77
TIP: Actuator is supported natively with Spring MVC, Spring WebFlux, and Jersey.
8-
If both Jersey and Spring MVC are available, Spring MVC will be used.
8+
If both Jersey and Spring MVC are available, Spring MVC is used.
99

1010
NOTE: Jackson is a required dependency in order to get the correct JSON responses as documented in the API documentation ({spring-boot-actuator-restapi-docs}[HTML] or {spring-boot-actuator-restapi-pdfdocs}[PDF]).
1111

@@ -27,7 +27,7 @@ You can use the configprop:management.endpoints.web.base-path[] property to chan
2727

2828
The preceding `application.properties` example changes the endpoint from `/actuator/\{id}` to `/manage/\{id}` (for example, `/manage/info`).
2929

30-
NOTE: Unless the management port has been configured to <<actuator#actuator.monitoring.customizing-management-server-port,expose endpoints by using a different HTTP port>>, `management.endpoints.web.base-path` is relative to `server.servlet.context-path` (Servlet web applications) or `spring.webflux.base-path` (reactive web applications).
30+
NOTE: Unless the management port has been configured to <<actuator#actuator.monitoring.customizing-management-server-port,expose endpoints by using a different HTTP port>>, `management.endpoints.web.base-path` is relative to `server.servlet.context-path` (for servlet web applications) or `spring.webflux.base-path` (for reactive web applications).
3131
If `management.server.port` is configured, `management.endpoints.web.base-path` is relative to `management.server.base-path`.
3232

3333
If you want to map endpoints to a different path, you can use the configprop:management.endpoints.web.path-mapping[] property.
@@ -60,15 +60,15 @@ You can set the configprop:management.server.port[] property to change the HTTP
6060
port: 8081
6161
----
6262

63-
NOTE: On Cloud Foundry, applications only receive requests on port 8080 for both HTTP and TCP routing, by default.
64-
If you want to use a custom management port on Cloud Foundry, you will need to explicitly set up the application's routes to forward traffic to the custom port.
63+
NOTE: On Cloud Foundry, by default, applications receive requests only on port 8080 for both HTTP and TCP routing.
64+
If you want to use a custom management port on Cloud Foundry, you need to explicitly set up the application's routes to forward traffic to the custom port.
6565

6666

6767

6868
[[actuator.monitoring.management-specific-ssl]]
6969
=== Configuring Management-specific SSL
70-
When configured to use a custom port, the management server can also be configured with its own SSL by using the various `management.server.ssl.*` properties.
71-
For example, doing so lets a management server be available over HTTP while the main application uses HTTPS, as shown in the following property settings:
70+
When configured to use a custom port, you can also configure the management server with its own SSL by using the various `management.server.ssl.*` properties.
71+
For example, doing so lets a management server be available over HTTP while the main application uses HTTPS, as the following property settings show:
7272

7373
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
7474
----
@@ -108,7 +108,7 @@ Alternatively, both the main server and the management server can use SSL but wi
108108

109109
[[actuator.monitoring.customizing-management-server-address]]
110110
=== Customizing the Management Server Address
111-
You can customize the address that the management endpoints are available on by setting the configprop:management.server.address[] property.
111+
You can customize the address on which the management endpoints are available by setting the configprop:management.server.address[] property.
112112
Doing so can be useful if you want to listen only on an internal or ops-facing network or to listen only for connections from `localhost`.
113113

114114
NOTE: You can listen on a different address only when the port differs from the main server port.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
== Process Monitoring
33
In the `spring-boot` module, you can find two classes to create files that are often useful for process monitoring:
44

5-
* `ApplicationPidFileWriter` creates a file containing the application PID (by default, in the application directory with a file name of `application.pid`).
6-
* `WebServerPortFileWriter` creates a file (or files) containing the ports of the running web server (by default, in the application directory with a file name of `application.port`).
5+
* `ApplicationPidFileWriter` creates a file that contains the application PID (by default, in the application directory with a file name of `application.pid`).
6+
* `WebServerPortFileWriter` creates a file (or files) that contain the ports of the running web server (by default, in the application directory with a file name of `application.port`).
77

8-
By default, these writers are not activated, but you can enable:
8+
By default, these writers are not activated, but you can enable them:
99

1010
* <<actuator#actuator.process-monitoring.configuration,By Extending Configuration>>
1111
* <<actuator#actuator.process-monitoring.programmatically>>
@@ -14,7 +14,7 @@ By default, these writers are not activated, but you can enable:
1414

1515
[[actuator.process-monitoring.configuration]]
1616
=== Extending Configuration
17-
In the `META-INF/spring.factories` file, you can activate the listener(s) that writes a PID file, as shown in the following example:
17+
In the `META-INF/spring.factories` file, you can activate the listener (or listeners) that writes a PID file:
1818

1919
[indent=0]
2020
----
@@ -26,6 +26,6 @@ In the `META-INF/spring.factories` file, you can activate the listener(s) that w
2626

2727

2828
[[actuator.process-monitoring.programmatically]]
29-
=== Programmatically
29+
=== Programmatically Enabling Process Monitoring
3030
You can also activate a listener by invoking the `SpringApplication.addListeners(...)` method and passing the appropriate `Writer` object.
3131
This method also lets you customize the file name and path in the `Writer` constructor.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[[actuator.tracing]]
22
== HTTP Tracing
33
You can enable HTTP Tracing by providing a bean of type `HttpTraceRepository` in your application's configuration.
4-
For convenience, Spring Boot offers an `InMemoryHttpTraceRepository` that stores traces for the last 100 request-response exchanges, by default.
5-
`InMemoryHttpTraceRepository` is limited compared to other tracing solutions and we recommend using it only for development environments.
6-
For production environments, use of a production-ready tracing or observability solution, such as Zipkin or Spring Cloud Sleuth, is recommended.
7-
Alternatively, create your own `HttpTraceRepository` that meets your needs.
4+
For convenience, Spring Boot offers `InMemoryHttpTraceRepository`, which stores traces for the last 100 (the default) request-response exchanges.
5+
`InMemoryHttpTraceRepository` is limited compared to other tracing solutions, and we recommend using it only for development environments.
6+
For production environments, we recommend using a production-ready tracing or observability solution, such as Zipkin or Spring Cloud Sleuth.
7+
Alternatively, you can create your own `HttpTraceRepository`.
88

99
You can use the `httptrace` endpoint to obtain information about the request-response exchanges that are stored in the `HttpTraceRepository`.
1010

0 commit comments

Comments
 (0)