Commit a02c2d41 authored by Andy Wilkinson's avatar Andy Wilkinson

Improve the documentation of Health.Status constants

Closes gh-7784
parent 9695e0a9
/* /*
* 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
......
...@@ -38,22 +38,25 @@ import org.springframework.util.ObjectUtils; ...@@ -38,22 +38,25 @@ import org.springframework.util.ObjectUtils;
public final class Status { 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"); 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"); 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"); 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"); public static final Status OUT_OF_SERVICE = new Status("OUT_OF_SERVICE");
......
...@@ -1063,7 +1063,7 @@ content into your application; rather pick only the properties that you need. ...@@ -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.rabbit.enabled=true # Enable RabbitMQ health check.
management.health.redis.enabled=true # Enable Redis health check. management.health.redis.enabled=true # Enable Redis health check.
management.health.solr.enabled=true # Enable Solr 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]) # INFO CONTRIBUTORS ({sc-spring-boot-actuator}/autoconfigure/InfoContributorProperties.{sc-ext}[InfoContributorProperties])
management.info.build.enabled=true # Enable build info. management.info.build.enabled=true # Enable build info.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment