You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/monitoring/endpoints.adoc
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,8 +145,9 @@ Therefore, details such as `leader` and `raftCommandsPerSecond` are database-spe
145
145
--------------
146
146
====
147
147
148
+
[[status-endpoint-descriptions]]
148
149
.Status endpoint descriptions
149
-
[options="header", cols="2,1,1,2,4"]
150
+
[options="header", cols="2,1,1,2,4a"]
150
151
|===
151
152
| Field | Type |Optional| Example | Description
152
153
| `core` | boolean | no | `true` | Used to distinguish between if the server is hosting the database in primary (core) or secondary mode.
@@ -158,7 +159,15 @@ Therefore, details such as `leader` and `raftCommandsPerSecond` are database-spe
158
159
| `votingMembers` | string[] | no | `[]` | A member is considered a voting member when the leader has been receiving communication with it.
159
160
160
161
List of member's `memberId` that are considered part of the voting set by this primary.
161
-
| `isHealthy` | boolean | no | `true` | Reflects that the local database of this member has not encountered a critical error preventing it from writing locally.
162
+
| `isHealthy` | boolean | no | `true` | Indicates that the local database on this cluster member has not encountered a critical error that can block database operation.
163
+
164
+
[CAUTION]
165
+
====
166
+
The `isHealthy` status applies only to this member's local database.
167
+
It does not reflect the overall health of the database if it is clustered.
168
+
169
+
A cluster member may still report `"isHealthy": true` even if the database currently has no leader and so cannot accept write transactions.
170
+
====
162
171
| `memberId` | string | no | `30edc1c4-519c-4030-8348-7cb7af44f591` | Every member in a cluster has it's own unique member id to identify it.
163
172
Use `memberId` to distinguish between primary and secondary servers.
164
173
| `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.
@@ -171,6 +180,8 @@ It is recommended to use the metric `<prefix>.clustering.core.commit_index` on e
171
180
172
181
After an instance has been switched on, the status endpoint can be accessed in order to make sure all the guarantees listed in the table below are met.
173
182
183
+
184
+
174
185
To get the most accurate view of a cluster it is strongly recommended to access the _status endpoint_ on all primary members and compare the result.
175
186
The following table explains how results can be compared.
0 commit comments