Skip to content

Commit 165facf

Browse files
Clarify database health status (#2380)
Copied from the PR #2370
1 parent c255dfe commit 165facf

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

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

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,19 +139,24 @@ 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.
146146
| `lastAppliedRaftIndex` | number | no | `4321` | Every transaction in a cluster is associated with a raft index.
147-
148-
Gives an indication of what the latest applied raft log index is.
147+
Gives an indication of what the latest applied raft log index is.
149148
| `participatingInRaftGroup` | boolean | no | `false` | A participating member is able to vote.
150149
A Core is considered participating when it is part of the voter membership and has kept track of the leader.
151150
| `votingMembers` | string[] | no | `[]` | A member is considered a voting member when the leader has been receiving communication with it.
151+
List of member's `memberId` that are considered part of the voting set by this Core.
152+
| `isHealthy` | boolean | no | `true` | Indicates that the local database on this cluster member has not encountered a critical error that can block database operation.
152153

153-
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+
[CAUTION]
155+
====
156+
The `isHealthy` status applies only to this member's local database.
157+
It does not reflect the overall health of the database if it is clustered.
158+
A cluster member may still report `"isHealthy": true` even if the database currently has no leader and so cannot accept write transactions.
159+
====
155160
| `memberId` | string | no | `30edc1c4-519c-4030-8348-7cb7af44f591` | Every member in a cluster has it's own unique member id to identify it.
156161
Use `memberId` to distinguish between Core and Read Replica.
157162
| `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)