Skip to content

Commit 6f58033

Browse files
Change wording in show instances part of HA docs (#949)
* change wording in show instances part of HA docs * fix wording2 --------- Co-authored-by: Kruno Golubic <[email protected]>
1 parent 87f8397 commit 6f58033

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

pages/clustering/high-availability.mdx

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -270,15 +270,19 @@ This operation will result in writing to the Raft log.
270270

271271
### Show instances
272272

273-
You can check the state of the whole cluster using the `SHOW INSTANCES` query. The query will show which instances are visible in the cluster,
274-
which network ports they are using for managing cluster state, whether they are considered alive from the coordinator's
275-
perspective, their role (are they MAIN, REPLICA, LEADER, FOLLOWER or unknown if not alive) and the response time
276-
from instances to the leader's ping. This query can be run both on the leader and followers. Since only the leader knows the exact state of health state and response time,
277-
followers will do the following actions in exact order:
278-
1. Try contacting the leader to get the state of the cluster, since the leader has all the information.
279-
If the leader responds, the follower will return the result as if SHOW INSTANCES was run by the leader.
280-
2. When the leader doesn't respond, or currently there is no leader, the follower will return all the data instances and coordinators
281-
in the cluster but with the health state and last response time set to 0, respectively.
273+
You can check the state of the whole cluster using the `SHOW INSTANCES` query. The query will display all the Memgraph servers visible in the cluster. With
274+
each server you can see the following information:
275+
1. Network ports they are using for managing cluster state
276+
2. Health state of server
277+
3. Role - MAIN, REPLICA, LEADER, FOLLOWER or unknown if not alive
278+
4. The time passed since the last response time to the leader's health ping
279+
280+
This query can be run on either the leader or followers. Since only the leader knows the exact status of the health state and last response time,
281+
followers will execute actions in this exact order:
282+
1. Try contacting the leader to get the health state of the cluster, since the leader has all the information.
283+
If the leader responds, the follower will return the result as if the `SHOW INSTANCES` query was run on the leader.
284+
2. When the leader doesn't respond or currently there is no leader, the follower will return all the Memgraph servers
285+
with the health state set to "down".
282286

283287
```plaintext
284288
SHOW INSTANCES;

0 commit comments

Comments
 (0)