From a708b28d9d5baea0cb650a869752d0f004486782 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 25 Nov 2014 12:22:23 +0000 Subject: [PATCH] Document restrictions when /health is accessed anonymously Closes gh-1978 --- .../main/asciidoc/production-ready-features.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index fd03432e7e..b944409752 100644 --- a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -410,6 +410,22 @@ If you don't want to expose endpoints over HTTP you can set the management port +[[production-ready-health-access-restrictions]] +=== Health endpoint anonymous access restrictions +The information exposed by the health endpoint varies depending on whether or not it's +accessed anonymously. When accessed anonymously, any details about the server's health +are hidden and the endpoint will simply indicate whether or not the server is up or +down. Furthermore, when accessed anonymously, the response is cached for a configurable +period to prevent the endpoint being used in a denial of service attack. +The `endpoints.health.time-to-live` property is used to configure the caching period in +milliseconds. It defaults to 1000, i.e. one second. + +The above-described restrictions can be disabled, thereby allowing anonymous users full +access to the health endpoint. To do so, set `endpoints.health.restrict-anonymous-access` +to `false`. + + + [[production-ready-jmx]] == Monitoring and management over JMX Java Management Extensions (JMX) provide a standard mechanism to monitor and manage