Skip to content

Commit 9f4cea0

Browse files
Further updates to health check endpoint docs
* Remove documentation to the now deprecated One True Health Check™. It is too intrusive and too prone to false positives to recommend. * Aliveness test is also a health check, and will respond with a 200 or 503 as of #856
1 parent c1a1bc9 commit 9f4cea0

File tree

1 file changed

+4
-36
lines changed

1 file changed

+4
-36
lines changed

deps/rabbitmq_management/priv/www/api/index.html

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -951,42 +951,10 @@ <h2>Reference</h2>
951951
<td></td>
952952
<td class="path">/api/aliveness-test/<i>vhost</i></td>
953953
<td>
954-
Declares a test queue, then publishes and consumes a
955-
message. Intended for use by monitoring tools. If everything
956-
is working correctly, will return HTTP status 200 with
957-
body: <pre>{"status":"ok"}</pre> Note: the test queue will
958-
not be deleted (to prevent queue churn if this is
959-
repeatedly pinged).
960-
</td>
961-
</tr>
962-
<tr>
963-
<td>X</td>
964-
<td></td>
965-
<td></td>
966-
<td></td>
967-
<td class="path">/api/healthchecks/node</td>
968-
<td>
969-
Runs basic healthchecks in the current node. Checks that the rabbit
970-
application is running, channels and queues can be listed successfully, and
971-
that no alarms are in effect. If everything is working correctly, will
972-
return HTTP status 200 with body: <pre>{"status":"ok"}</pre> If
973-
something fails, will return HTTP status 200 with the body of
974-
<pre>{"status":"failed","reason":"string"}</pre>
975-
</td>
976-
</tr>
977-
<tr>
978-
<td>X</td>
979-
<td></td>
980-
<td></td>
981-
<td></td>
982-
<td class="path">/api/healthchecks/node/<i>node</i></td>
983-
<td>
984-
Runs basic healthchecks in the given node. Checks that the rabbit
985-
application is running, list_channels and list_queues return, and
986-
that no alarms are raised. If everything is working correctly, will
987-
return HTTP status 200 with body: <pre>{"status":"ok"}</pre> If
988-
something fails, will return HTTP status 200 with the body of
989-
<pre>{"status":"failed","reason":"string"}</pre>
954+
Declares a test queue on the target node, then publishes and consumes a
955+
message. Intended to be used as a very basic health check.
956+
Responds a 200 OK if the check succeeded,
957+
otherwise responds with a 503 Service Unavailable.
990958
</td>
991959
</tr>
992960
<tr>

0 commit comments

Comments
 (0)