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
|`MaxRetryClusterHealth`|`4h`| Retry interval for re-probing unavailable nodes. `0` = use default, `<0` = disable probing entirely.|
86
-
|`HealthCheckRequestModifier`|`nil`| Callback applied to every health check request (both `GET /` and `/_cluster/health`). Use this to inject custom auth headers. |
83
+
| Config Field | Default | Description |
84
+
| --- | --- | --- |
85
+
|`MaxRetryClusterHealth`|`4h`| Retry interval for re-probing unavailable nodes. `0` = use default, `<0` = disable probing entirely. |
86
+
|`HealthCheckRequestModifier`|`nil`| Callback applied to every health check request (both `GET /` and `/_cluster/health`). Use this to inject custom auth headers. |
|`green`| All primary and replica shards are assigned.|
133
+
| Status | Meaning |
134
+
| --- | --- |
135
+
|`green`| All primary and replica shards are assigned. |
136
136
|`yellow`| All primary shards are assigned, but some replicas are not. The cluster is functional but not fully redundant. |
137
-
|`red`| Some primary shards are unassigned. Data loss or unavailability may be occurring.|
137
+
|`red`| Some primary shards are unassigned. Data loss or unavailability may be occurring. |
138
138
139
139
A single-node development cluster will always report `yellow` because there is no second node to host replica shards. This is expected and does not indicate a problem.
140
140
@@ -150,16 +150,16 @@ The client uses poll-and-parse instead: issue the request, read the `status` fie
| All requests succeed with no credentials. | Requests without valid credentials return **401**. |
282
-
| No permission checks. | Requests with valid credentials but missing `cluster:monitor/health` privilege return **403**. |
279
+
| Before security | After security |
280
+
| --- | --- |
281
+
| All requests succeed with no credentials. | Requests without valid credentials return **401**. |
282
+
| No permission checks. | Requests with valid credentials but missing `cluster:monitor/health` privilege return **403**. |
283
283
284
284
If the client is performing health checks and the cluster enables security, health probes will begin returning 401. This is expected. The client should surface this condition clearly rather than reporting the cluster as unhealthy: the cluster is reachable, but credentials need to be configured.
|`RequestTimeout`| Per-attempt | Each individual HTTP round-trip (including each retry)|
72
-
|`context.WithTimeout`| Total | The entire operation across all attempts and backoff delays |
69
+
| Mechanism | Scope | Applies to |
70
+
| --- | --- | --- |
71
+
|`RequestTimeout`| Per-attempt | Each individual HTTP round-trip (including each retry) |
72
+
|`context.WithTimeout`| Total | The entire operation across all attempts and backoff delays |
73
73
74
74
Use both together for defense in depth: `RequestTimeout` prevents any single attempt from hanging indefinitely, while a context deadline caps the total wall-clock time.
0 commit comments