root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Document new health check endpoints

This commit is contained in:
dcorbacho 2020-10-16 11:48:56 +01:00
parent 6162328593
commit ea37d7dd67
1 changed files with 110 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
deps/rabbitmq_management/priv/www/api/index.html vendored
View File

@ -989,6 +989,116 @@ or:
<pre>{"status":"failed","reason":"string"}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/alarms</td>
<td>
Checks that no alarms are raised. If everything is working correctly, will
return HTTP status 200 with body: <pre>{"status":"ok"}</pre> If
something fails, will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","alarms":[{"resource":"string","node":"string"}]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/local-alarms</td>
<td>
Checks that no alarms are raised in the given node.
If everything is working correctly, will
return HTTP status 200 with body: <pre>{"status":"ok"}</pre> If
something fails, will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","alarms":[{"resource":"string","node":"string"}]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/certificate-expiration/<i>within</i>/<i>unit</i></td>
<td>
Checks the expiration date on the certificates for every listener configured to use TLS.
If all certificates are valid it will return HTTP status 200 with body: <pre>{"status":"ok"}</pre> If any certificate expires, will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","expired":[{"node":"string","protocol":"string","interface":"string","port":"integer","certfile":"string","cacertfile":"string","certfile_expires_on":"string","cacertfile_expires_on":"string"}]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/port-listener/<i>port</i></td>
<td>
Checks if there is an active listener in the given node. If there is a listener it will
return HTTP status 200 with body: <pre>{"status":"ok","port":"integer"}</pre>.
If there is no active listener, will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","missing":"integer","ports":["integer"]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/protocol-listener/<i>protocol</i></td>
<td>
Checks if there is an active listener for given protocol. If there is a listener it will
return HTTP status 200 with body: <pre>{"status":"ok","protocol":"string"}</pre>.
If there is no active listener, will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","missing":"integer","protocols":["string"]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/virtual-hosts</td>
<td>
Checks if all vhosts are running in the given node. If everything is working
correctly it will return HTTP status 200 with body: <pre>{"status":"ok"}</pre>.
If there is any failure, will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","virtual-hosts":["string"]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/node-is-mirror-sync-critical</td>
<td>
Checks if there are classic mirrored queues without online synchronised mirrors
(queues that would potentially lose data if the target node is shut down).
If everything is working correctly it will return HTTP status 200 with body:
<pre>{"status":"ok"}</pre>.
If there is any classic mirrored queue without online synchronised mirrors,
will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","queues":[{"name":"string","readable_name":"string","virtual_host":"string","type":"string"}]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td class="path">/api/health/checks/node-is-quorum-critical</td>
<td>
Checks if there are quorum queues with minimum online quorum (queues that
would lose their quorum if the target node is shut down).
If everything is working correctly it will return HTTP status 200 with body:
<pre>{"status":"ok"}</pre>.
If there is any quorum queue with minimum online quorum,
will return HTTP status 503 with the body of
<pre>{"status":"failed","reason":"string","queues":[{"name":"string","readable_name":"string","virtual_host":"string","type":"string"}]}</pre>
</td>
</tr>
<tr>
<td>X</td>
<td></td>