root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

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
This commit is contained in:
Jay Bryant 2021-09-08 12:50:08 -07:00 committed by Phillip Webb
parent e44585d89a
commit 53363c84cb
5 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -349,7 +349,7 @@ You can do so by changing the configprop:management.endpoints.web.exposure.inclu
include: "*" include: "*"
---- ----
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: 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:
[source,java,indent=0,subs="verbatim"] [source,java,indent=0,subs="verbatim"]
---- ----
@ -476,7 +476,7 @@ Consider the following JSON request body:
} }
---- ----
This can be used to invoke a write operation that takes `String name` and `int counter` parameters, as shown in the following example: You can use this to invoke a write operation that takes `String name` and `int counter` parameters, as the following example shows:
[source,java,indent=0,subs="verbatim"] [source,java,indent=0,subs="verbatim"]
---- ----

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

@ -41,7 +41,7 @@ The following settings show an example of doing so in `application.properties`:
[[actuator.jmx.disable-jmx-endpoints]] [[actuator.jmx.disable-jmx-endpoints]]
=== Disabling JMX Endpoints === Disabling JMX Endpoints
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: 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:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -81,7 +81,7 @@ The endpoint will not be available in a WebFlux application.
==== Customizing Jolokia ==== Customizing Jolokia
Jolokia has a number of settings that you would traditionally configure by setting servlet parameters. Jolokia has a number of settings that you would traditionally configure by setting servlet parameters.
With Spring Boot, you can use your `application.properties` file. With Spring Boot, you can use your `application.properties` file.
To do so, prefix the parameter with `management.endpoint.jolokia.config.`, as shown in the following example: To do so, prefix the parameter with `management.endpoint.jolokia.config.`, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----

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

@ -19,7 +19,7 @@ These levels can be one of:
[[actuator.loggers.configure]] [[actuator.loggers.configure]]
=== Configure a Logger === Configure a Logger
To configure a given logger, `POST` a partial entity to the resource's URI, as shown in the following example: To configure a given logger, `POST` a partial entity to the resource's URI, as the following example shows:
[source,json,indent=0,subs="verbatim"] [source,json,indent=0,subs="verbatim"]
---- ----

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

@ -32,7 +32,7 @@ Having a dependency on `micrometer-registry-\{system}` in your runtime classpath
Most registries share common features. Most registries share common features.
For instance, you can disable a particular registry even if the Micrometer registry implementation is on the classpath. For instance, you can disable a particular registry even if the Micrometer registry implementation is on the classpath.
For example, to disable Datadog: The following example disables Datadog:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -43,7 +43,7 @@ For example, to disable Datadog:
enabled: false enabled: false
---- ----
You can also disable all registries unless stated otherwise by the registry-specific property, as shown in the following example: You can also disable all registries unless stated otherwise by the registry-specific property, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -232,6 +232,7 @@ For the v1 API, the base environment URI must be specified without a path as the
===== Version-independent Settings ===== Version-independent Settings
In addition to the API endpoint and token, you can also change the interval at which metrics are sent to Dynatrace. In addition to the API endpoint and token, you can also change the interval at which metrics are sent to Dynatrace.
The default export interval is `60s`. The default export interval is `60s`.
The following example sets the export interval to 30 seconds:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -263,7 +264,7 @@ The location of the Elastic server to use can be provided using the following pr
[[actuator.metrics.export.ganglia]] [[actuator.metrics.export.ganglia]]
==== Ganglia ==== Ganglia
By default, metrics are exported to {micrometer-registry-docs}/ganglia[Ganglia] running on your local machine. By default, metrics are exported to {micrometer-registry-docs}/ganglia[Ganglia] running on your local machine.
The http://ganglia.sourceforge.net[Ganglia server] host and port to use can be provided using: You can provide the http://ganglia.sourceforge.net[Ganglia server] host and port, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -280,7 +281,7 @@ The http://ganglia.sourceforge.net[Ganglia server] host and port to use can be p
[[actuator.metrics.export.graphite]] [[actuator.metrics.export.graphite]]
==== Graphite ==== Graphite
By default, metrics are exported to {micrometer-registry-docs}/graphite[Graphite] running on your local machine. By default, metrics are exported to {micrometer-registry-docs}/graphite[Graphite] running on your local machine.
The https://graphiteapp.org[Graphite server] host and port to use can be provided using: You can provide the https://graphiteapp.org[Graphite server] host and port, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -447,7 +448,7 @@ Spring Boot provides an actuator endpoint available at `/actuator/prometheus` to
TIP: The endpoint is not available by default and must be exposed, see <<actuator#actuator.endpoints.exposing,exposing endpoints>> for more details. TIP: The endpoint is not available by default and must be exposed, see <<actuator#actuator.endpoints.exposing,exposing endpoints>> for more details.
Here is an example `scrape_config` to add to `prometheus.yml`: The following example `scrape_config` adds to `prometheus.yml`:
[source,yaml,indent=0,subs="verbatim"] [source,yaml,indent=0,subs="verbatim"]
---- ----
@ -968,7 +969,7 @@ Each metric is tagged with the following information by default:
| Outcome of the command - one of (`SUCCESS`, `FAILED`) | Outcome of the command - one of (`SUCCESS`, `FAILED`)
|=== |===
To replace the default metric tags, define a `MongoCommandTagsProvider` bean, as shown in the following example: To replace the default metric tags, define a `MongoCommandTagsProvider` bean, as the following example shows:
[source,java,indent=0,subs="verbatim"] [source,java,indent=0,subs="verbatim"]
---- ----
@ -1110,7 +1111,7 @@ These use the global registry that is not Spring-managed.
[[actuator.metrics.customizing.common-tags]] [[actuator.metrics.customizing.common-tags]]
==== Common Tags ==== Common Tags
Common tags are generally used for dimensional drill-down on the operating environment like host, instance, region, stack, etc. Common tags are generally used for dimensional drill-down on the operating environment like host, instance, region, stack, etc.
Commons tags are applied to all meters and can be configured as shown in the following example: Commons tags are applied to all meters and can be configured, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -1132,7 +1133,7 @@ As the order of common tags cannot be guaranteed using this approach, Graphite u
==== Per-meter Properties ==== Per-meter Properties
In addition to `MeterFilter` beans, it's also possible to apply a limited set of customization on a per-meter basis using properties. In addition to `MeterFilter` beans, it's also possible to apply a limited set of customization on a per-meter basis using properties.
Per-meter customizations apply to any all meter IDs that start with the given name. Per-meter customizations apply to any all meter IDs that start with the given name.
For example, the following will disable any meters that have an ID starting with `example.remote` The following example disables any meters that have an ID starting with `example.remote`
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----

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

@ -15,7 +15,7 @@ NOTE: Jackson is a required dependency in order to get the correct JSON response
=== Customizing the Management Endpoint Paths === Customizing the Management Endpoint Paths
Sometimes, it is useful to customize the prefix for the management endpoints. Sometimes, it is useful to customize the prefix for the management endpoints.
For example, your application might already use `/actuator` for another purpose. For example, your application might already use `/actuator` for another purpose.
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: You can use the configprop:management.endpoints.web.base-path[] property to change the prefix for your management endpoint, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -51,7 +51,7 @@ The following example remaps `/actuator/health` to `/healthcheck`:
Exposing management endpoints by using the default HTTP port is a sensible choice for cloud-based deployments. Exposing management endpoints by using the default HTTP port is a sensible choice for cloud-based deployments.
If, however, your application runs inside your own data center, you may prefer to expose endpoints by using a different HTTP port. If, however, your application runs inside your own data center, you may prefer to expose endpoints by using a different HTTP port.
You can set the configprop:management.server.port[] property to change the HTTP port, as shown in the following example: You can set the configprop:management.server.port[] property to change the HTTP port, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -127,7 +127,7 @@ The following example `application.properties` does not allow remote management
[[actuator.monitoring.disabling-http-endpoints]] [[actuator.monitoring.disabling-http-endpoints]]
=== Disabling HTTP Endpoints === Disabling HTTP Endpoints
If you do not want to expose endpoints over HTTP, you can set the management port to `-1`, as shown in the following example: If you do not want to expose endpoints over HTTP, you can set the management port to `-1`, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
@ -136,7 +136,7 @@ If you do not want to expose endpoints over HTTP, you can set the management por
port: -1 port: -1
---- ----
This can be achieved using the configprop:management.endpoints.web.exposure.exclude[] property as well, as shown in the following example: You can also achieve this by using the configprop:management.endpoints.web.exposure.exclude[] property, as the following example shows:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----