Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Disable the java info contributor by default

Browse Source 
Closes gh-28310

Co-authored-by Phillip Webb <pwebb@vmware.com>
This commit is contained in:
Andy Wilkinson
2021-10-19 15:07:14 +01:00
parent f2b3f1f41f
commit f98c1e7231
8 changed files with 128 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1145,24 +1145,41 @@ Spring Boot includes a number of auto-configured `InfoContributor` beans, and yo
==== Auto-configured InfoContributors
When appropriate, Spring auto-configures the following `InfoContributor` beans:
[cols="1,4"]
[cols="1,4,8,4"]
|===
| Name | Description
| {spring-boot-actuator-module-code}/info/EnvironmentInfoContributor.java[`EnvironmentInfoContributor`]
| Exposes any key from the `Environment` under the `info` key.
| {spring-boot-actuator-module-code}/info/GitInfoContributor.java[`GitInfoContributor`]
| Exposes git information if a `git.properties` file is available.
| ID | Name | Description | Prequisites
| `build`
| {spring-boot-actuator-module-code}/info/BuildInfoContributor.java[`BuildInfoContributor`]
| Exposes build information if a `META-INF/build-info.properties` file is available.
| Exposes build information.
| A `META-INF/build-info.properties` resource.
| `env`
| {spring-boot-actuator-module-code}/info/EnvironmentInfoContributor.java[`EnvironmentInfoContributor`]
| Exposes any property from the `Environment` whose name starts with `info.`.
| None.
| `git`
| {spring-boot-actuator-module-code}/info/GitInfoContributor.java[`GitInfoContributor`]
| Exposes git information.
| A `git.properties` resource.
| `java`
| {spring-boot-actuator-module-code}/info/JavaInfoContributor.java[`JavaInfoContributor`]
| Exposes Java runtime information under the `java` key.
| Exposes Java runtime information.
| None.
|===
TIP: You can disable them all by setting the configprop:management.info.defaults.enabled[] property.
Whether or not an individual contributor is enabled is controlled by its `management.info.<id>.enabled` property.
Different contributors have different defaults for this property, depending on their prerequisites and the nature of the information that they expose.
With no prequisites to indicate that it should be enabled, the `java` contributor is disabled by default.
You can enable it by setting the configprop:management.info.java.enabled[] property to `true`.
The `env`, `git`, and `build` info contributors are enabled by default.
Each can be disabled by setting its `management.info.<id>.enabled` property to `false`.
Alternatively, to disable every contributor that is usually enabled by default, set the configprop:management.info.defaults.enabled[] property to `false`.