From a02c2d4155fa56be0cadc32336e9635e8b601022 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 17 Jan 2017 14:58:30 +0000 Subject: [PATCH] Improve the documentation of Health.Status constants Closes gh-7784 --- .../boot/actuate/health/OrderedHealthAggregator.java | 2 +- .../springframework/boot/actuate/health/Status.java | 11 +++++++---- .../asciidoc/appendix-application-properties.adoc | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/OrderedHealthAggregator.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/OrderedHealthAggregator.java index ee2f12762f4..ad2e7c81704 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/OrderedHealthAggregator.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/OrderedHealthAggregator.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2014 the original author or authors. + * Copyright 2012-2017 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java index bb0e7321dd8..d4c189e1024 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java @@ -38,22 +38,25 @@ import org.springframework.util.ObjectUtils; public final class Status { /** - * Convenient constant value representing unknown state. + * {@link Status} indicating that the component or subsystem is in an unknown state. */ public static final Status UNKNOWN = new Status("UNKNOWN"); /** - * Convenient constant value representing up state. + * {@link Status} indicating that the component or subsystem is functioning as + * expected. */ public static final Status UP = new Status("UP"); /** - * Convenient constant value representing down state. + * {@link Status} indicating that the component or subsystem has suffered an + * unexpected failure. */ public static final Status DOWN = new Status("DOWN"); /** - * Convenient constant value representing out-of-service state. + * {@link Status} indicating that the component or subsystem has been taken out of + * service and should not be used. */ public static final Status OUT_OF_SERVICE = new Status("OUT_OF_SERVICE"); diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index bc057d4b81f..3e2cded3644 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -1063,7 +1063,7 @@ content into your application; rather pick only the properties that you need. management.health.rabbit.enabled=true # Enable RabbitMQ health check. management.health.redis.enabled=true # Enable Redis health check. management.health.solr.enabled=true # Enable Solr health check. - management.health.status.order=DOWN, OUT_OF_SERVICE, UNKNOWN, UP # Comma-separated list of health statuses in order of severity. + management.health.status.order=DOWN, OUT_OF_SERVICE, UP, UNKNOWN # Comma-separated list of health statuses in order of severity. # INFO CONTRIBUTORS ({sc-spring-boot-actuator}/autoconfigure/InfoContributorProperties.{sc-ext}[InfoContributorProperties]) management.info.build.enabled=true # Enable build info.