Skip to content

Commit 6bf837e

Browse files
committed
Tidy up documentation following removal of /status and /health changes
Closes gh-10863
1 parent 3b1d2b0 commit 6bf837e

File tree

1 file changed

+4
-65
lines changed

1 file changed

+4
-65
lines changed

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

Lines changed: 4 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -333,10 +333,10 @@ moves to a child context with all the other web endpoints.
333333
=== Health Information
334334
You can use health information to check the status of your running application. It is
335335
often used by monitoring software to alert someone when a production system goes down.
336-
The default information exposed by the `health` endpoint depends on how it is accessed.
337-
For an unauthenticated connection in a secure application, a simple '`status`' message is
338-
returned. For an authenticated connection, additional details are also displayed. (See
339-
<<production-ready-health-access-restrictions>> for HTTP details.)
336+
The information exposed by the `health` endpoint depends on the
337+
`management.endpoint.health.show-details` property. By default, the property's value is
338+
`false` and a simple '`status`' message is returned. When the property's value is set to
339+
`true`, additional details from the individual health indicators are also displayed.
340340

341341
Health information is collected from all
342342
{sc-spring-boot-actuator}/health/HealthIndicator.{sc-ext}[`HealthIndicator`] beans
@@ -785,67 +785,6 @@ If you do not want to expose endpoints over HTTP, you can set the management por
785785
----
786786

787787

788-
[[production-ready-health-access-restrictions]]
789-
=== HTTP Health Endpoint Format and Access Restrictions
790-
The information exposed by the health endpoint varies, depending on whether it is
791-
accessed anonymously and whether the enclosing application is secure. By default, when
792-
accessed anonymously in a secure application, any details about the server's health are
793-
hidden and the endpoint indicates whether the server is up or down.
794-
795-
The following example shows a summarized HTTP response (default for anonymous request):
796-
797-
[source,indent=0]
798-
----
799-
$ curl -i localhost:8080/health
800-
HTTP/1.1 200
801-
X-Application-Context: application
802-
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
803-
Content-Length: 15
804-
805-
{"status":"UP"}
806-
----
807-
808-
The following example shows a summarized HTTP response for status "DOWN" (notice the 503
809-
status code):
810-
811-
[source,indent=0]
812-
----
813-
$ curl -i localhost:8080/health
814-
HTTP/1.1 503
815-
X-Application-Context: application
816-
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
817-
Content-Length: 17
818-
819-
{"status":"DOWN"}
820-
----
821-
822-
The following example shows a detailed HTTP response:
823-
824-
[source,indent=0]
825-
----
826-
$ curl -i localhost:8080/health
827-
HTTP/1.1 200 OK
828-
X-Application-Context: application
829-
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
830-
Content-Length: 221
831-
832-
{
833-
"status" : "UP",
834-
"diskSpace" : {
835-
"status" : "UP",
836-
"total" : 63251804160,
837-
"free" : 31316164608,
838-
"threshold" : 10485760
839-
},
840-
"db" : {
841-
"status" : "UP",
842-
"database" : "H2",
843-
"hello" : 1
844-
}
845-
}
846-
----
847-
848-
849788

850789
[[production-ready-jmx]]
851790
== Monitoring and Management over JMX

0 commit comments

Comments
 (0)