Skip to content

Commit 53363c8

Browse files
Jay Bryantphilwebb
authored andcommitted
Improve actuator example lead-in text
Update example lead-in text to a slightly shorter form. For example "as shown in the following example" Becomes "as the following example shows" See gh-27759
1 parent e44585d commit 53363c8

File tree

5 files changed

+18
-17
lines changed

5 files changed

+18
-17
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ You can do so by changing the configprop:management.endpoints.web.exposure.inclu
349349
include: "*"
350350
----
351351

352-
Additionally, if Spring Security is present, you would need to add custom security configuration that allows unauthenticated access to the endpoints as shown in the following example:
352+
Additionally, if Spring Security is present, you would need to add custom security configuration that allows unauthenticated access to the endpoints, as the following example shows:
353353

354354
[source,java,indent=0,subs="verbatim"]
355355
----
@@ -476,7 +476,7 @@ Consider the following JSON request body:
476476
}
477477
----
478478

479-
This can be used to invoke a write operation that takes `String name` and `int counter` parameters, as shown in the following example:
479+
You can use this to invoke a write operation that takes `String name` and `int counter` parameters, as the following example shows:
480480

481481
[source,java,indent=0,subs="verbatim"]
482482
----

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following settings show an example of doing so in `application.properties`:
4141

4242
[[actuator.jmx.disable-jmx-endpoints]]
4343
=== Disabling JMX Endpoints
44-
If you do not want to expose endpoints over JMX, you can set the configprop:management.endpoints.jmx.exposure.exclude[] property to `*`, as shown in the following example:
44+
If you do not want to expose endpoints over JMX, you can set the configprop:management.endpoints.jmx.exposure.exclude[] property to `*`, as the following example shows:
4545

4646
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
4747
----
@@ -81,7 +81,7 @@ The endpoint will not be available in a WebFlux application.
8181
==== Customizing Jolokia
8282
Jolokia has a number of settings that you would traditionally configure by setting servlet parameters.
8383
With Spring Boot, you can use your `application.properties` file.
84-
To do so, prefix the parameter with `management.endpoint.jolokia.config.`, as shown in the following example:
84+
To do so, prefix the parameter with `management.endpoint.jolokia.config.`, as the following example shows:
8585

8686
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
8787
----

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ These levels can be one of:
1919

2020
[[actuator.loggers.configure]]
2121
=== Configure a Logger
22-
To configure a given logger, `POST` a partial entity to the resource's URI, as shown in the following example:
22+
To configure a given logger, `POST` a partial entity to the resource's URI, as the following example shows:
2323

2424
[source,json,indent=0,subs="verbatim"]
2525
----

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Having a dependency on `micrometer-registry-\{system}` in your runtime classpath
3232

3333
Most registries share common features.
3434
For instance, you can disable a particular registry even if the Micrometer registry implementation is on the classpath.
35-
For example, to disable Datadog:
35+
The following example disables Datadog:
3636

3737
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
3838
----
@@ -43,7 +43,7 @@ For example, to disable Datadog:
4343
enabled: false
4444
----
4545

46-
You can also disable all registries unless stated otherwise by the registry-specific property, as shown in the following example:
46+
You can also disable all registries unless stated otherwise by the registry-specific property, as the following example shows:
4747

4848
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
4949
----
@@ -232,6 +232,7 @@ For the v1 API, the base environment URI must be specified without a path as the
232232
===== Version-independent Settings
233233
In addition to the API endpoint and token, you can also change the interval at which metrics are sent to Dynatrace.
234234
The default export interval is `60s`.
235+
The following example sets the export interval to 30 seconds:
235236

236237
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
237238
----
@@ -263,7 +264,7 @@ The location of the Elastic server to use can be provided using the following pr
263264
[[actuator.metrics.export.ganglia]]
264265
==== Ganglia
265266
By default, metrics are exported to {micrometer-registry-docs}/ganglia[Ganglia] running on your local machine.
266-
The http://ganglia.sourceforge.net[Ganglia server] host and port to use can be provided using:
267+
You can provide the http://ganglia.sourceforge.net[Ganglia server] host and port, as the following example shows:
267268

268269
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
269270
----
@@ -280,7 +281,7 @@ The http://ganglia.sourceforge.net[Ganglia server] host and port to use can be p
280281
[[actuator.metrics.export.graphite]]
281282
==== Graphite
282283
By default, metrics are exported to {micrometer-registry-docs}/graphite[Graphite] running on your local machine.
283-
The https://graphiteapp.org[Graphite server] host and port to use can be provided using:
284+
You can provide the https://graphiteapp.org[Graphite server] host and port, as the following example shows:
284285

285286
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
286287
----
@@ -447,7 +448,7 @@ Spring Boot provides an actuator endpoint available at `/actuator/prometheus` to
447448

448449
TIP: The endpoint is not available by default and must be exposed, see <<actuator#actuator.endpoints.exposing,exposing endpoints>> for more details.
449450

450-
Here is an example `scrape_config` to add to `prometheus.yml`:
451+
The following example `scrape_config` adds to `prometheus.yml`:
451452

452453
[source,yaml,indent=0,subs="verbatim"]
453454
----
@@ -968,7 +969,7 @@ Each metric is tagged with the following information by default:
968969
| Outcome of the command - one of (`SUCCESS`, `FAILED`)
969970
|===
970971

971-
To replace the default metric tags, define a `MongoCommandTagsProvider` bean, as shown in the following example:
972+
To replace the default metric tags, define a `MongoCommandTagsProvider` bean, as the following example shows:
972973

973974
[source,java,indent=0,subs="verbatim"]
974975
----
@@ -1110,7 +1111,7 @@ These use the global registry that is not Spring-managed.
11101111
[[actuator.metrics.customizing.common-tags]]
11111112
==== Common Tags
11121113
Common tags are generally used for dimensional drill-down on the operating environment like host, instance, region, stack, etc.
1113-
Commons tags are applied to all meters and can be configured as shown in the following example:
1114+
Commons tags are applied to all meters and can be configured, as the following example shows:
11141115

11151116
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
11161117
----
@@ -1132,7 +1133,7 @@ As the order of common tags cannot be guaranteed using this approach, Graphite u
11321133
==== Per-meter Properties
11331134
In addition to `MeterFilter` beans, it's also possible to apply a limited set of customization on a per-meter basis using properties.
11341135
Per-meter customizations apply to any all meter IDs that start with the given name.
1135-
For example, the following will disable any meters that have an ID starting with `example.remote`
1136+
The following example disables any meters that have an ID starting with `example.remote`
11361137

11371138
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
11381139
----

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ NOTE: Jackson is a required dependency in order to get the correct JSON response
1515
=== Customizing the Management Endpoint Paths
1616
Sometimes, it is useful to customize the prefix for the management endpoints.
1717
For example, your application might already use `/actuator` for another purpose.
18-
You can use the configprop:management.endpoints.web.base-path[] property to change the prefix for your management endpoint, as shown in the following example:
18+
You can use the configprop:management.endpoints.web.base-path[] property to change the prefix for your management endpoint, as the following example shows:
1919

2020
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
2121
----
@@ -51,7 +51,7 @@ The following example remaps `/actuator/health` to `/healthcheck`:
5151
Exposing management endpoints by using the default HTTP port is a sensible choice for cloud-based deployments.
5252
If, however, your application runs inside your own data center, you may prefer to expose endpoints by using a different HTTP port.
5353

54-
You can set the configprop:management.server.port[] property to change the HTTP port, as shown in the following example:
54+
You can set the configprop:management.server.port[] property to change the HTTP port, as the following example shows:
5555

5656
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
5757
----
@@ -127,7 +127,7 @@ The following example `application.properties` does not allow remote management
127127

128128
[[actuator.monitoring.disabling-http-endpoints]]
129129
=== Disabling HTTP Endpoints
130-
If you do not want to expose endpoints over HTTP, you can set the management port to `-1`, as shown in the following example:
130+
If you do not want to expose endpoints over HTTP, you can set the management port to `-1`, as the following example shows:
131131

132132
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
133133
----
@@ -136,7 +136,7 @@ If you do not want to expose endpoints over HTTP, you can set the management por
136136
port: -1
137137
----
138138

139-
This can be achieved using the configprop:management.endpoints.web.exposure.exclude[] property as well, as shown in the following example:
139+
You can also achieve this by using the configprop:management.endpoints.web.exposure.exclude[] property, as the following example shows:
140140

141141
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
142142
----

0 commit comments

Comments
 (0)