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

Document HealthIndicator naming convention 

Closes gh-4602
This commit is contained in:
Stephane Nicoll 2015-11-27 17:21:15 +01:00
parent 9d29ab73a4
commit 754642e0cf
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View File

@ -323,7 +323,7 @@ additional details to be displayed.
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
@Component @Component
public class MyHealth implements HealthIndicator { public class MyHealthIndicator implements HealthIndicator {
@Override @Override
public Health health() { public Health health() {
@ -337,6 +337,10 @@ additional details to be displayed.
} }
---- ----
NOTE: The identifier for a given `HealthIndicator` is the name of the bean without the
`HealthIndicator` suffix if it exists. In the example above, the health information will
be available in an entry named `my`.
In addition to Spring Boot's predefined {sc-spring-boot-actuator}/health/Status.{sc-ext}[`Status`] In addition to Spring Boot's predefined {sc-spring-boot-actuator}/health/Status.{sc-ext}[`Status`]
types, it is also possible for `Health` to return a custom `Status` that represents a types, it is also possible for `Health` to return a custom `Status` that represents a
new system state. In such cases a custom implementation of the new system state. In such cases a custom implementation of the