Skip to content

Commit 689febe

Browse files
Clarify database health status
1 parent c255dfe commit 689febe

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Therefore, details such as `leader` and `raftCommandsPerSecond` are database spe
139139
====
140140

141141
.Status endpoint descriptions
142-
[options="header", cols="2,1,1,2,4"]
142+
[options="header", cols="2,1,1,2,4a"]
143143
|===
144144
| Field | Type |Optional| Example | Description
145145
| `core` | boolean | no | `true` | Used to distinguish between Core Servers and Read Replicas.
@@ -151,7 +151,14 @@ Therefore, details such as `leader` and `raftCommandsPerSecond` are database spe
151151
| `votingMembers` | string[] | no | `[]` | A member is considered a voting member when the leader has been receiving communication with it.
152152

153153
List of member's `memberId` that are considered part of the voting set by this Core.
154-
| `isHealthy` | boolean | no | `true` | Reflects that the local database of this member has not encountered a critical error preventing it from writing locally.
154+
| `isHealthy` | boolean | no | `true` | Indicates that the local database on this cluster member has not encountered a critical error that can block database operation.
155+
156+
[CAUTION]
157+
====
158+
The `isHealthy` status applies only to this member's local database.
159+
It does not reflect the overall health of the database if it is clustered.
160+
A cluster member may still report `"isHealthy": true` even if the database currently has no leader and so cannot accept write transactions.
161+
====
155162
| `memberId` | string | no | `30edc1c4-519c-4030-8348-7cb7af44f591` | Every member in a cluster has it's own unique member id to identify it.
156163
Use `memberId` to distinguish between Core and Read Replica.
157164
| `leader` | string | yes | `80a7fb7b-c966-4ee7-88a9-35db8b4d68fe` | Follows the same format as `memberId`, but if it is null or missing, then the leader is unknown.

0 commit comments

Comments
 (0)