Skip to content

Commit 253fe63

Browse files
author
Pablo Alcantar Morales
authored
Add shards capacity troubleshooting guide (#95208)
1 parent ba9dc81 commit 253fe63

File tree

5 files changed

+580
-1
lines changed

5 files changed

+580
-1
lines changed

docs/reference/health/health.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ watermark threshold>>.
381381
The `invocations_since_last_success` key will report a map where the unhealthy policy
382382
name is the key and it's corresponding number of failed invocations is the value.
383383

384-
[[health-api-response-details-shards-usage]]
384+
[[health-api-response-details-shards-capacity]]
385385
===== shards_capacity
386386
`data`::
387387
(map) A view with information about the current capacity of shards for data nodes that do not belong to the frozen tier.
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
2+
[discrete]
3+
=== Cluster is close to reaching the configured maximum number of shards for data nodes.
4+
5+
The <<cluster-max-shards-per-node,`cluster.max_shards_per_node`>> cluster
6+
setting limits the maximum number of open shards for a cluster, only counting data nodes
7+
that do not belong to the frozen tier.
8+
9+
This symptom indicates that action should be taken, otherwise, either the creation of new
10+
indices or upgrading the cluster could be blocked.
11+
12+
If you're confident your changes won't destabilize the cluster, you can
13+
temporarily increase the limit using the <<cluster-update-settings,cluster update settings API>>:
14+
15+
++++
16+
<div class="tabs" data-tab-group="host">
17+
<div role="tablist" aria-label="Troubleshoot shards capacity for non-frozen nodes">
18+
<button role="tab"
19+
aria-selected="true"
20+
aria-controls="cloud-tab-shards-capacity-non-frozen"
21+
id="cloud-shards-capacity-non-frozen">
22+
Elasticsearch Service
23+
</button>
24+
<button role="tab"
25+
aria-selected="false"
26+
aria-controls="self-managed-tab-shards-capacity-non-frozen"
27+
id="self-managed-shards-capacity-non-frozen"
28+
tabindex="-1">
29+
Self-managed
30+
</button>
31+
</div>
32+
<div tabindex="0"
33+
role="tabpanel"
34+
id="cloud-tab-shards-capacity-non-frozen"
35+
aria-labelledby="cloud-shards-capacity-non-frozen">
36+
++++
37+
38+
include::troubleshooting-shards-capacity.asciidoc[tag=non-frozen-nodes-cloud]
39+
40+
++++
41+
</div>
42+
<div tabindex="0"
43+
role="tabpanel"
44+
id="self-managed-tab-shards-capacity-non-frozen"
45+
aria-labelledby="self-managed-shards-capacity-non-frozen"
46+
hidden="">
47+
++++
48+
49+
include::troubleshooting-shards-capacity.asciidoc[tag=non-frozen-nodes-self-managed]
50+
51+
++++
52+
</div>
53+
</div>
54+
++++
55+
56+
[discrete]
57+
=== Cluster is close to reaching the configured maximum number of shards for frozen nodes.
58+
59+
The <<cluster-max-shards-per-node-frozen,`cluster.max_shards_per_node.frozen`>> cluster
60+
setting limits the maximum number of open shards for a cluster, only counting data nodes
61+
that belong to the frozen tier.
62+
63+
This symptom indicates that action should be taken, otherwise, either the creation of new
64+
indices or upgrading the cluster could be blocked.
65+
66+
If you're confident your changes won't destabilize the cluster, you can
67+
temporarily increase the limit using the <<cluster-update-settings,cluster update settings API>>:
68+
69+
++++
70+
<div class="tabs" data-tab-group="host">
71+
<div role="tablist" aria-label="Troubleshoot shards capacity for frozen nodes">
72+
<button role="tab"
73+
aria-selected="true"
74+
aria-controls="cloud-tab-shards-capacity-frozen"
75+
id="cloud-shards-capacity">
76+
Elasticsearch Service
77+
</button>
78+
<button role="tab"
79+
aria-selected="false"
80+
aria-controls="self-managed-tab-shards-capacity-frozen"
81+
id="self-managed-shards-capacity-frozen"
82+
tabindex="-1">
83+
Self-managed
84+
</button>
85+
</div>
86+
<div tabindex="0"
87+
role="tabpanel"
88+
id="cloud-tab-shards-capacity-frozen"
89+
aria-labelledby="cloud-shards-capacity-frozen">
90+
++++
91+
92+
include::troubleshooting-shards-capacity.asciidoc[tag=frozen-nodes-cloud]
93+
94+
++++
95+
</div>
96+
<div tabindex="0"
97+
role="tabpanel"
98+
id="self-managed-tab-shards-capacity-frozen"
99+
aria-labelledby="self-managed-shards-capacity-frozen"
100+
hidden="">
101+
++++
102+
103+
include::troubleshooting-shards-capacity.asciidoc[tag=frozen-nodes-self-managed]
104+
105+
++++
106+
</div>
107+
</div>
108+
++++

0 commit comments

Comments
 (0)