Skip to content

Commit 691cb9a

Browse files
committed
Merge pull request #18170 from dreis2211
* pr/18170: Polish "Remove management.health.status.order from docs" Fix link formatting in custom HealthIndicator section Remove management.health.status.order from docs Closes gh-18170
2 parents 14a6760 + ae34ae7 commit 691cb9a

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthProperties.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import java.util.Set;
2424

2525
import org.springframework.boot.actuate.health.HealthEndpoint;
26+
import org.springframework.boot.context.properties.NestedConfigurationProperty;
2627

2728
/**
2829
* Properties used to configure the health endpoint and endpoint groups.
@@ -33,6 +34,7 @@
3334
*/
3435
public abstract class HealthProperties {
3536

37+
@NestedConfigurationProperty
3638
private final Status status = new Status();
3739

3840
/**

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@
2828
"name": "management.endpoint.health.show-details",
2929
"defaultValue": "never"
3030
},
31+
{
32+
"name": "management.endpoint.health.status.order",
33+
"defaultValue": [
34+
"DOWN",
35+
"OUT_OF_SERVICE",
36+
"UP",
37+
"UNKNOWN"
38+
]
39+
},
3140
{
3241
"name": "management.endpoints.enabled-by-default",
3342
"type": "java.lang.Boolean",

spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -748,7 +748,7 @@ NOTE: The identifier for a given `HealthIndicator` is the name of the bean witho
748748
In the preceding example, the health information is available in an entry named `my`.
749749

750750
In addition to Spring Boot's predefined {spring-boot-actuator-module-code}/health/Status.java[`Status`] types, it is also possible for `Health` to return a custom `Status` that represents a new system state.
751-
In such cases, a custom implementation of the{spring-boot-actuator-module-code}/health/StatusAggregator.java[`StatusAggregator`] interface also needs to be provided, or the default implementation has to be configured by using the `management.endpoint.health.status.order` configuration property.
751+
In such cases, a custom implementation of the {spring-boot-actuator-module-code}/health/StatusAggregator.java[`StatusAggregator`] interface also needs to be provided, or the default implementation has to be configured by using the `management.endpoint.health.status.order` configuration property.
752752

753753
For example, assume a new `Status` with code `FATAL` is being used in one of your `HealthIndicator` implementations.
754754
To configure the severity order, add the following property to your application properties:

0 commit comments

Comments
 (0)