@@ -29,8 +29,9 @@ include::{snippets}health/response-fields.adoc[]
29
29
30
30
[[health-retrieving-component]]
31
31
== Retrieving the Health of a component
32
- To retrieve the health of a particular component of the application, make a `GET` request
33
- to `/actuator/health/\{component}`, as shown in the following curl-based example:
32
+ To retrieve the health of a particular component of the application's health, make a
33
+ `GET` request to `/actuator/health/\{component}`, as shown in the following curl-based
34
+ example:
34
35
35
36
include::{snippets}health/component/curl-request.adoc[]
36
37
@@ -42,27 +43,32 @@ include::{snippets}health/component/http-response.adoc[]
42
43
43
44
[[health-retrieving-component-response-structure]]
44
45
=== Response Structure
45
- The response contains details of the health of a particular component of the application.
46
- The following table describes the structure of the response:
46
+ The response contains details of the health of a particular component of the
47
+ application's health. The following table describes the structure of the response:
47
48
48
49
[cols="2,1,3"]
49
50
include::{snippets}health/component/response-fields.adoc[]
50
51
51
52
52
53
53
- [[health-retrieving-component-instance ]]
54
- == Retrieving the Health of a component instance
55
- If a particular component consists of multiple instances (as the `broker` indicator in
56
- the example above), the health of a particular instance of that component can be retrieved
57
- by issuing a `GET` request to `/actuator/health/\{component}/\{instance }`, as shown in the
58
- following curl-based example:
54
+ [[health-retrieving-component-nested ]]
55
+ == Retrieving the Health of a nested component
56
+ If a particular component contains other nested components (as the `broker` indicator in
57
+ the example above), the health of such a nested component can be retrieved by issuing a
58
+ `GET` request to `/actuator/health/\{component}/\{subcomponent }`, as shown in the following
59
+ curl-based example:
59
60
60
61
include::{snippets}health/instance/curl-request.adoc[]
61
62
62
63
The resulting response is similar to the following:
63
64
64
65
include::{snippets}health/instance/http-response.adoc[]
65
66
67
+ Components of an application's health may be nested arbitrarily deep depending on the
68
+ application's health indicators and how they have been grouped. The health endpoint
69
+ supports any number of `/\{component}` identifiers in the URL to allow the health of a
70
+ component at any depth to be retrieved.
71
+
66
72
67
73
68
74
[[health-retrieving-component-instance-response-structure]]
0 commit comments