Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc- backport cluster health API documentation (#4938)

This commit is contained in:
Jan 2018-03-23 12:20:40 +01:00 committed by sleto-it
parent b34eb1c23f
commit f9b6bd8dfa
2 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/Books/HTTP/AdministrationAndMonitoring/README.md
View File

@ -1,7 +1,6 @@
HTTP Interface for Administration and Monitoring
================================================
This is an introduction to ArangoDB's HTTP interface for administration and
monitoring of the server.
@ -37,6 +36,10 @@ monitoring of the server.
@startDocuBlock JSF_get_admin_server_id
## Cluster
<!-- js/actions/api-cluster.js -->
@startDocuBlock JSF_cluster_statistics_GET
@startDocuBlock get_cluster_health

28
Documentation/DocuBlocks/Rest/Cluster/get_cluster_health.md Normal file
View File

@ -0,0 +1,28 @@
@startDocuBlock get_cluster_health
@brief Returns the health of the cluster as assessed by the supervision (agency)
@RESTHEADER{GET /_admin/cluster/health, Queries the health of cluster for monitoring}
@RESTDESCRIPTION
Queries the health of the cluster for monitoring purposes. The response is a JSON object, containing the standard `code`, `error`, `errorNum`, and `errorMessage` fields as appropriate. The endpoint-specific fields are as follows:
- `ClusterId`: A UUID string identifying the cluster
- `Health`: An object containing a descriptive sub-object for each node in the cluster. Each entry in `Health` will be keyed by the node ID and contain the the following attributes:
- `Endpoint`: A string representing the network endpoint of the server.
- `Role`: The role the server plays. Possible values are `"AGENT"`, `"COORDINATOR"`, and `"DBSERVER"`.
- `CanBeDeleted`: Boolean representing whether the node can safely be removed from the cluster.
Additionally, if the node is a Coordinator or DBServer, it will also have the following attributes:
- `Status`: A string indicating the health of the node as assessed by the supervision (agency). This should be considered primary source of truth for node health. If the node is responding normally to requests, it is `"GOOD"`. If it has missed one heartbeat, it is `"BAD"`. If it has been declared failed by the supervision, which occurs after missing heartbeats for about 15 seconds, it will be marked `"FAILED"`.
- `SyncStatus`: The last sync status reported by the node. This value is primarily used to determine the value of `Status`. Possible values include `"UNKNOWN"`, `"UNDEFINED"`, `"STARTUP"`, `"STOPPING"`, `"STOPPED"`, `"SERVING"`, `"SHUTDOWN"`.
- `ShortName`: A string representing the shortname of the server, e.g. `"DBServer1"`.
- `Timestamp`: ISO 8601 timestamp specifying the last heartbeat received.
- `Host`: An optional string, specifying the host machine if known.
@RESTRETURNCODES
@RESTRETURNCODE{200} is returned when everything went well.
@endDocuBlock