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

Polish "Document HTTP response format of health endpoint"

Browse Source 
Closes gh-8703
This commit is contained in:
Stephane Nicoll
2017-04-10 14:01:50 +02:00
parent 1fa1ed2b28
commit fd53945fe0
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -382,9 +382,15 @@ to your application properties:
management.health.status.order=DOWN, OUT_OF_SERVICE, UNKNOWN, UP
----
You might also want to register custom status mappings with the `HealthMvcEndpoint`
if you access the health endpoint over HTTP. For example you could map `FATAL` to
`HttpStatus.SERVICE_UNAVAILABLE`.
The HTTP status code in the response reflects the overall health status (e.g. `UP`
maps to 200, `OUT_OF_SERVICE` or `DOWN` to 503). You might also want to register custom
status mappings with the `HealthMvcEndpoint` if you access the health endpoint over HTTP.
For example, the following maps `FATAL` to `HttpStatus.SERVICE_UNAVAILABLE`:
[source,properties,indent=0]
----
endpoints.health.mappings.FATAL=503
----
@@ -688,10 +694,6 @@ endpoint being used in a denial of service attack. The `endpoints.health.time-to
property is used to configure the caching period in milliseconds. It defaults to 1000,
i.e. one second.
The HTTP status code in the response reflects the overall health status (e.g. “UP”=200,
“OUT_OF_SERVICE”=503, “DOWN”=503). The mappings can be changed by configuring
`endpoints.health.mapping.<STATUS>=XXX`.
Sample summarized HTTP response (default for anonymous request):
[source,indent=0]