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

Add support for health indicator groups

Browse Source 
Update the `HealthEndpoint` to support health groups. The
`HealthEndpointSettings` interface has been replaced with
`HealthEndpointGroups` which provides access to the primary group
as well as an optional set of additional groups.

Groups can be configured via properties and may have custom
`StatusAggregator` and `HttpCodeStatusMapper` settings.

Closes gh-14022

Co-authored-by: Stephane Nicoll <snicoll@pivotal.io>
This commit is contained in:
Phillip Webb
2019-08-20 14:09:04 -07:00
parent f09e0264d9
commit e03f822c6d
36 changed files with 1598 additions and 366 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -951,6 +951,42 @@ TIP: If necessary, reactive indicators replace the regular ones. Also, any
==== Health Groups
It's sometimes useful to organize health indicators into groups that can be used for
different purposes. For example, if you deploy your application to Kubernetes, you may
want one different sets of health indicators for your "`liveness`" and "`readiness`"
probes.
To create a health indicator group you can use the `management.endpoint.health.group.<name>`
property and specify a list of health indicator IDs to `include` or `exclude`. For example,
to create a group that includes only database indicators you can define the following:
[source,properties,indent=0]
----
management.endpoint.health.group.custom.include=db
----
You can then check the result by hitting `http://localhost:8080/actuator/health/custom`.
By default groups will inherit the same `StatusAggregator` and `HttpCodeStatusMapper`
settings as the system health, however, these can also be defined on a per-group
basis. It's also possible to override the `show-details` and `roles` properties
if required:
[source,properties,indent=0]
----
management.endpoint.health.group.custom.show-details=when-authorized
management.endpoint.health.group.custom.roles=admin
management.endpoint.health.group.custom.status.order=fatal,up
management.endpoint.health.group.custom.status.http-mapping.fatal=500
----
TIP: You can use `@Qualifier("groupname")` if you need to register custom
`StatusAggregator` or `HttpCodeStatusMapper` beans for use with the group.
[[production-ready-application-info]]
=== Application Information
Application information exposes various information collected from all