Polish "Document HTTP response format of health endpoint"

Closes gh-8703
pull/8929/head
Stephane Nicoll 8 years ago
parent 1fa1ed2b28
commit fd53945fe0

@ -382,9 +382,15 @@ to your application properties:
management.health.status.order=DOWN, OUT_OF_SERVICE, UNKNOWN, UP management.health.status.order=DOWN, OUT_OF_SERVICE, UNKNOWN, UP
---- ----
You might also want to register custom status mappings with the `HealthMvcEndpoint` The HTTP status code in the response reflects the overall health status (e.g. `UP`
if you access the health endpoint over HTTP. For example you could map `FATAL` to maps to 200, `OUT_OF_SERVICE` or `DOWN` to 503). You might also want to register custom
`HttpStatus.SERVICE_UNAVAILABLE`. 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, property is used to configure the caching period in milliseconds. It defaults to 1000,
i.e. one second. 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): Sample summarized HTTP response (default for anonymous request):
[source,indent=0] [source,indent=0]

Loading…
Cancel
Save