From 689febe27299583daf2a3256601a0fafad35fea6 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Mon, 2 Jun 2025 14:33:52 +0200 Subject: [PATCH 1/2] Clarify database health status --- .../monitoring/causal-cluster/http-endpoints.adoc | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc b/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc index 0b8f30aa6..4d0af4b9f 100644 --- a/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc +++ b/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc @@ -139,7 +139,7 @@ Therefore, details such as `leader` and `raftCommandsPerSecond` are database spe ==== .Status endpoint descriptions -[options="header", cols="2,1,1,2,4"] +[options="header", cols="2,1,1,2,4a"] |=== | Field | Type |Optional| Example | Description | `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 | `votingMembers` | string[] | no | `[]` | A member is considered a voting member when the leader has been receiving communication with it. List of member's `memberId` that are considered part of the voting set by this Core. -| `isHealthy` | boolean | no | `true` | Reflects that the local database of this member has not encountered a critical error preventing it from writing locally. +| `isHealthy` | boolean | no | `true` | Indicates that the local database on this cluster member has not encountered a critical error that can block database operation. + +[CAUTION] +==== +The `isHealthy` status applies only to this member's local database. +It does not reflect the overall health of the database if it is clustered. +A cluster member may still report `"isHealthy": true` even if the database currently has no leader and so cannot accept write transactions. +==== | `memberId` | string | no | `30edc1c4-519c-4030-8348-7cb7af44f591` | Every member in a cluster has it's own unique member id to identify it. Use `memberId` to distinguish between Core and Read Replica. | `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. From b20da5fa8cb4e8d5f8665ba8e15a03f35764c137 Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Mon, 2 Jun 2025 15:50:58 +0200 Subject: [PATCH 2/2] Fix table syntax --- .../pages/monitoring/causal-cluster/http-endpoints.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc b/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc index 4d0af4b9f..c76adc34b 100644 --- a/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc +++ b/modules/ROOT/pages/monitoring/causal-cluster/http-endpoints.adoc @@ -144,13 +144,11 @@ Therefore, details such as `leader` and `raftCommandsPerSecond` are database spe | Field | Type |Optional| Example | Description | `core` | boolean | no | `true` | Used to distinguish between Core Servers and Read Replicas. | `lastAppliedRaftIndex` | number | no | `4321` | Every transaction in a cluster is associated with a raft index. - - Gives an indication of what the latest applied raft log index is. +Gives an indication of what the latest applied raft log index is. | `participatingInRaftGroup` | boolean | no | `false` | A participating member is able to vote. A Core is considered participating when it is part of the voter membership and has kept track of the leader. | `votingMembers` | string[] | no | `[]` | A member is considered a voting member when the leader has been receiving communication with it. - - List of member's `memberId` that are considered part of the voting set by this Core. +List of member's `memberId` that are considered part of the voting set by this Core. | `isHealthy` | boolean | no | `true` | Indicates that the local database on this cluster member has not encountered a critical error that can block database operation. [CAUTION]